如何在Eclipse中如何自动添加注释和自定义注释风格

Posted 2023-04-23

参考技术A 1. 如何自动添加注释
可通过如下三种方法自动添加注释：
（1）输入“/**”并回车。
（2）用快捷键 Alt＋Shift+J（先选中某个方法、类名或变量名）。
（3）在右键菜单中选择“Source > Generate ElementComment”。

2. 如何自定义注释风格
自带的注释格式你不一定喜欢或不符合你公司的标准，那么可以通过下面方法进行修改。
（1）Window->Preference 打开参数设置面板，然后选择：Java -> Code Style -> CodeTemplates

可以看到Comments下面一系列可以注释的Java代码组成部分（对文件、变量、方法、构造方法、重载函数等等），比如我想定制Java文件的注释风格，那么在右侧选择Comments中的File项，点击Edit，进入编辑模式，这样就可以自定义注释了。其中可以插入一些变量，如日期、文件名、作者等等。
3. 导入/导出代码格式模板

如果你辛辛苦苦定制好了自己的代码风格，然后换了台机器进行操作或重装了Eclipse，是不是要重新配置一遍呢？答案当然是No了，Eclipse提供了“导出”和“导入”功能，你可以把自己的模板导出来在其他机器上使用。 参考技术B 自定义注释：
1、xml里面的注释 preferences-----Ant------Formatter
2、java里面的注释 preferences-----Editor---Syntax Coloring
3、text里面的注释preferences-----Editor---Propertites Files Editor 参考技术C shift+alt 自动添加注释方法注释，类注释

设置风格请参考这个：http://jingyan.baidu.com/article/e75aca85771274142edac62b.html

如何防止 Eclipse 格式化程序在注释中的注释后添加空格？

【中文标题】如何防止 Eclipse 格式化程序在注释中的注释后添加空格？

【英文标题】：How to prevent Eclipse formatter from adding a whitespace after annotations in annotations?

【发布时间】：2016-01-01 23:12:21

【问题描述】：

当我格式化这段代码时：

@JoinTable(name = "UTI_COLLECTER_CTN",
  joinColumns = @JoinColumn(name = "COD_UTI", referencedColumnName = "COD_UTI"),
  inverseJoinColumns = @JoinColumn(name = "COD_CTN", referencedColumnName = "COD_CTN"))

eclipse在注解的每个右括号后面加一个空格，像这样：

@JoinTable(name = "UTI_COLLECTER_CTN",
  joinColumns = @JoinColumn(name = "COD_UTI", referencedColumnName = "COD_UTI") ,
  inverseJoinColumns = @JoinColumn(name = "COD_CTN", referencedColumnName = "COD_CTN") )

如何预防？ （删除格式化程序配置中的所有空格不会改变任何东西......）

【参考方案1】：

终于找到了解决办法，我在内部注解前后加了大括号：

@JoinTable(name = "UTI_COLLECTER_CTN",
  joinColumns = @JoinColumn(name = "COD_UTI", referencedColumnName = "COD_UTI"),
  inverseJoinColumns = @JoinColumn(name = "COD_CTN", referencedColumnName = "COD_CTN"))

【参考方案2】：

1) 转到窗口 -> 首选项 -> Java -> 代码样式 -> 格式化程序

2) 点击“编辑”

3) 打开标签页空白

4) 展开“声明”

5) 点击注释

6) 您可以在下面找到白色间距的选项。

7) 删除​​“闭括号前”的粗体

我为此附上了图片。

【讨论】：

我的配置中未选中此复选框。我已经尝试删除空白选项卡中的所有检查。

也许有另一个 Formatter 干扰了您的代码？