我正在写一份白皮书，并意识到我不确定我们在定义声明之前作为注释块放置的那种内部文档的官方术语是什么。
最终成为 JavaDoc 成员文档的相同内容。
这不仅仅是内部文档，我不确定“标题文档”是否是一个好词。
请注意，我正在寻找一个通用术语，而不是特定于特定语言的术语（例如，Java/Perl）
Uri
问问题
209 次
6 回答
4
这称为方法规范或过程规范。也就是说，它指定了过程的行为而不是实现细节。一些教科书将其称为方法的合同，但这可能有点模棱两可。
于 2008-10-20T20:15:42.563 回答
3
在我的组织中，我们将其称为方法或函数 doc-comment。函数级文档可能是使用更广泛的术语。
于 2008-10-01T18:47:38.777 回答
3
我总是称它为方法（或函数）注释，以区别于类或文件注释。
于 2008-10-01T18:49:32.967 回答
0
它通常被专业地称为“要求条款”或“保险条款”。
于 2008-10-01T18:39:14.240 回答
0
我称之为代码注释，就这么简单。
于 2008-10-02T00:09:47.940 回答
0
我通常将其称为“内联文档”。对我来说，这就是它的意义所在——您的文档在源代码中，因此文档更有可能与代码保持同步。
(This is no guarantee, of course, but it does encourage programmers to eat their vegetables. It means the developer can change the documentation at the same time and in the same place the behavior changes, rather than after the fact and in another place.)
于 2008-10-20T20:28:40.557 回答