Eclipse格式化Javadoc注释时如何保留嵌套HTML标签的缩进
Eclipse格式化Javadoc注释时如何保留嵌套HTML标签的缩进
我太懂这种烦人的情况了——好好的嵌套HTML列表缩进,一格式化就被打回原形,复杂点的列表直接可读性暴跌!别担心,Eclipse其实有内置设置能解决这个问题,不用完全禁用Javadoc格式化,具体操作步骤如下:
- 打开Eclipse的偏好设置:Windows系统点顶部菜单栏的Window > Preferences,Mac系统则是Eclipse > Preferences
- 在左侧导航栏依次展开 Java > Code Style > Formatter
- 注意哦,默认的格式化配置是锁定状态不能直接修改的,得先点击Edit按钮,给自定义配置起个好记的名字(比如“我的Java格式化规则”),点击OK进入编辑界面
- 在弹出的编辑窗口里,切换到Javadoc标签页
- 找到Indentation设置区域,勾选保留用户定义的嵌套HTML元素缩进这类描述的选项(不同Eclipse版本 wording 稍有不同,核心是保留用户手动给HTML嵌套标签加的缩进)
- 依次点击Apply and Close保存配置,再点Preferences窗口的OK确认生效
设置完成后,再用Eclipse格式化代码时,Javadoc里的嵌套HTML标签缩进就会被保留下来,既享受自动格式化的便利,又不会破坏HTML结构的可读性。
如果碰到个别需要特殊处理的Javadoc块,也可以用局部禁用的小技巧:把Javadoc的开头从/**改成/*-,这样Eclipse就不会格式化这个特定的Javadoc了,但这个只适合特殊场景,全局设置才是一劳永逸的方案。
备注:内容来源于stack exchange,提问作者Harald
相关产品推荐
相关产品推荐

