メソッド宣言のすぐ上に置いたドキュメントの正しい用語は何ですか？

Question

ホワイトペーパーを書いていますが、定義の宣言の前にコメントブロックとして配置した内部ドキュメントの種類の正式な用語がわからないことに気付きました。

最終的にJavaDocメンバーのドキュメントとなるもの。

単なる内部ドキュメントではなく、「ヘッダードキュメント」もわかりません。良い言葉でしょう。

特定の言語（Java / Perlなど）に固有の用語ではなく、一般的な用語を探していることに注意してください

Answer 1

これは、メソッド仕様または手順仕様と呼ばれます。つまり、実装の詳細ではなく、プロシージャの動作を指定します。一部の教科書では、メソッドのコントラクトとしてそれを参照していますが、それは少し曖昧かもしれません。

Answer 2

私の組織では、これをメソッドまたは関数doc-commentと呼びます。機能レベルのドキュメントは、おそらくより広く使用されている用語です。

Answer 3

クラスまたはファイルのコメントと区別するために、常にメソッド（または関数）コメントと呼びます。

Answer 4

多くの場合、専門的に「要件条項」または「保険条項」と呼ばれています。

Answer 5

通常、「インラインドキュメント」と呼びます。私にとっては、それこそが＆＃8212;です。ドキュメントがソースコードにある という事実により、ドキュメントがコードと同期している可能性が高くなります。

（これはもちろん保証ではありませんが、プログラマーが野菜を食べることをお勧めします。開発者はドキュメントを同時におよび同じ場所で変更できることを意味します事後や別の場所ではなく、行動が変わります。）

Answer 6

私はそれをコードコメントと呼んでいます。そのように単純です。