内联代码文档

除了 Javadoc 之外，文档代码可以内联记录。

单行注释由//启动，可以在同一行上的语句之后定位，但不能在之前定位。

public void method() {
  
  //single line comment
  someMethodCall(); //single line comment after statement
  
}

/*和*/之间定义了多行注释。它们可以跨越多行，甚至可以放在语句之间。

public void method(Object object) {
  
  /*
    multi 
    line 
    comment
  */
  object/*inner-line-comment*/.method(); 
}

JavaDocs 是一种特殊形式的多行注释，从/**开始。

由于过多的内联注释可能会降低代码的可读性，因此如果代码不够自我解释或设计决策不明显，则应该稀疏地使用它们。

单行注释的另一个用例是使用 TAG，它是简短的常规驱动关键字。某些开发环境会识别此类单注释的某些约定。常见的例子是

• //TODO
• //FIXME

或者发布参考资料，即 Jira

• //PRJ-1234