內聯程式碼文件

除了 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