替换Java中内联或incode注释的注释

Question

我有一个要求，我想用in-line/in-code注释来描述一行代码。 e、 g使用单行注释

private foo(List myNameList){
    for(String name :  myNameList){

     //This prints each element of list
      System.out.println(name);
     }
} 

但是代码中的许多绿色注释看起来并不漂亮

我只是在寻找注释或解决方案，用注释替换每个注释 e、 g

private foo(List myNameList){
    for(String name :  myNameList){

      @Comment(n)
      System.out.println(name);

     }
   } 

只需将鼠标悬停在@Comment上，就会显示我的评论

注意：在注释（n）中，n是某个文本文件中我的消息/注释的索引

Answer 1

假设您是Eclipse用户（因此使用绿色注释），我认为您实际上应该做的是更改语法颜色，而不是开发注释

在Preferences中，转到Java -> Editor -> Syntax Coloring，在右边的框中展开Comments，并为每种类型的注释选择您想要的颜色（我建议为灰色）

另外，在Java -> Editor -> Folding中，确保选中了Comments

或者，您可以删除所有注释。但除非您编写自解释的代码，否则它是不行的。从无用的开始。重构他们解释的难以理解的代码

Answer 2

两个都不要用

如果你认为你需要写一条注释来解释一段代码的作用，那就不要写注释重构代码提取出小的、命名良好的方法，将逻辑分解为可理解的部分

代码中的内联注释应该很少，并且提供了无法通过阅读代码收集的信息：例如，为什么发生了什么

见：What is self-documenting code and can it replace well documented code?