如何修改Eclipse中Java类与方法的注释样式?
如何在Eclipse中配置自定义Java注释样式
别急,我一步步教你配置出你想要的注释格式,操作起来很清晰:
- 打开Eclipse的偏好设置:点击顶部菜单栏的
Window(Mac系统是Eclipse菜单),选择Preferences。 - 定位到代码格式化配置:展开左侧的
Java→Code Style→Formatter,点击Edit按钮(如果当前是默认配置,需要先点击New复制一份自定义配置,因为默认配置无法直接编辑)。 - 进入注释格式设置页面:在弹出的格式化配置窗口中,切换到
Comments标签页。 - 调整Javadoc注释的核心设置:
- 在
Javadoc comments的通用设置里,取消勾选「Start comment on new line」(这个选项会让/**单独占一行,取消后注释内容就能直接跟在/**后面)。 - 同样取消勾选「End comment on new line」,这样注释的结尾
*/会和最后一行注释内容放在同一行,而不是单独换行。 - 确保「Indent Javadoc comments」是勾选状态,这样多行注释的后续行会自动缩进并保留
*前缀。
- 在
- 统一应用到类、字段和方法:分别找到
Javadoc comments下的Class、Field、Method选项,给它们都应用上述的设置。 - 保存配置:给你的自定义格式化规则起个好记的名字,点击
OK,回到偏好设置页面后选中这个新配置,点击Apply and Close。 - 测试效果:右键点击目标Java类,选择
Source→Format,或者用快捷键Ctrl+Shift+F(Mac是Cmd+Shift+F),就能看到注释变成你想要的样式了。
另外,如果需要新建类/字段/方法时自动生成符合格式的注释,还需要调整代码模板:
- 回到偏好设置,展开
Java→Code Style→Code Templates。 - 找到
Comments下的Types(对应类)、Fields(成员变量)、Methods(方法),分别点击Edit:- 比如类的模板,把原来的多行模板:
修改为:/** * ${tags} *//**${tags}*/ - 字段和方法的模板也做类似修改,确保开头内容直接跟在
/**后,结尾*/和内容在同一行。
- 比如类的模板,把原来的多行模板:
内容的提问来源于stack exchange,提问作者Gero
相关产品推荐
相关产品推荐

