创建一个类 自动生成注释 里面有创建人,时间,类的名称 idea上怎么设置这个注释
时间: 2024-09-24 09:20:58 浏览: 54
IDEA类和方法注释模板设置(非常详细)
5星 · 资源好评率100%
在IntelliJ IDEA中,为了自动化生成包含创建人、时间和类名称的注释,你可以利用IDE内置的Javadoc模板功能。以下是设置步骤:
1. 打开IntelliJ IDEA,点击菜单栏 "File" (文件) > "Settings" (首选项,或者使用快捷键 `Ctrl + ,` 或 `Cmd + ,` )。
2. 在左侧导航树中选择 "Editor" (编辑器) > "Code Style" > "Documentation" (文档风格) > "JavaDoc"。
3. 在右侧的"Quick Documentation"或"Full Javadoc"区域,可以看到一个预设的模板区域,这是用于自定义模板的地方。
4. 点击 "Add" 按钮创建一个新的模板,然后输入你的模板内容,例如:
```xml
/**
* {TYPE} - {NAME}
*
* 创建于: {CREATE_DATE} 由 {CREATOR}
*
* @author {CREATOR}
* @since {CREATE_DATE}
*/
```
其中 `{TYPE}` 是类的类型(如Class),`{NAME}` 是类名,`{CREATE_DATE}` 是创建日期,`{CREATOR}` 是创建者的名字。
5. 右侧的占位符将会在生成Javadoc时被实际的项目数据替换,比如`{CREATE_DATE}`会被当前日期填充。
6. 完成后,记得将新的模板命名为方便识别的名称,比如 "MyDefaultTemplate"。
7. 若要应用这个模板,你可以直接添加新类的时候,按住 `Ctrl + Shift + I` 快捷键,系统会自动插入带有模板内容的注释。
8. 如果你想让这个模板作为默认模板,可以点击 "Use for 'New' and 'From Sources'"。
阅读全文