用Java替换内联或代码内注释的注释

Question

我有一个要求，我想在内嵌/代码内注释来描述一行代码。 例如使用单线注释

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上即可显示我的评论。

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

Answer 1

不要使用任何一种。

如果您认为需要撰写评论来解释一段代码的作用，请不要写评论。 重构代码。提取出小而命名良好的方法，将逻辑分解为可理解的部分。

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

请参阅：What is self-documenting code and can it replace well documented code?

Answer 2

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

在Preferences转到Java -> Editor -> Syntax Coloring，在右侧框中展开Comments，为每种评论选择您想要的颜色（我建议灰色）。

此外，在Java -> Editor -> Folding中，请务必选择Comments。

或者你可以删除所有评论。但除非你编写自解释代码，否则它不会做。从无用的开始。重构他们解释难以理解代码的地方。