我们在方法声明之上放置的文档的正确术语是什么？

Question

我正在写一份白皮书，并意识到我不确定在定义声明之前我们作为注释块放置的那种内部文档的正式术语。

同样最终成为JavaDoc成员文档。

这不仅仅是内部文档，而且我不确定“标题文档”是什么？这将是一个很好的术语。

请注意，我正在寻找一个通用术语，而不是特定于某种语言的术语（例如，Java / Perl）

Answer 1

这称为方法规范或过程规范。也就是说，它指定过程的行为而不是实现细节。有些教科书将其称为方法的合同，但可能有点含糊不清。

Answer 2

在我的组织中，我们将其称为方法或功能doc-comment。功能级文档可能是更广泛使用的术语。

Answer 3

我总是把它称为方法（或函数）注释，以区别于类或文件注释。

Answer 4

它通常被专业地称为“要求条款”或“保险条款”。

Answer 5

我通常将其称为“内联文档”。对我而言，这是关于它的＆＃8212;您的文档在源代码中的事实，因此文档更有可能与代码保持同步。

（当然，这并不能保证，但它确实鼓励程序员吃他们的蔬菜。这意味着开发人员可以在同一时间和同时更改文档 / em>行为改变，而不是在事实之后和在另一个地方。）

Answer 6

我把它称为代码注释，就像那样。