我正在写白皮书，并且意识到我不确定官方用语是指在定义定义之前放入注释框的内部文档类型。

最终成为JavaDoc成员文档的是同样的东西。

这不仅仅是内部文档，而且我不确定"标头文档"是否是一个好术语。

请注意，我在寻找的是通用术语，而不是特定于特定语言(例如Java / Perl)的术语

解决方案

它在专业上通常被称为"要求条款"或者"保险条款"。

在我的组织中，我们称其为方法或者函数文档注释。功能级文档可能是使用更广泛的术语。

我总是称其为方法(或者函数)注释，以区别于类或者文件注释。

我将其称为代码注释，就像这样简单。

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

我通常将其称为"内联文档"。对我来说，这就是文档位于源代码中的事实，因此，文档更有可能与代码保持同步。

(当然，这不能保证，但是它确实鼓励程序员吃菜。这意味着开发人员可以在同一时间和同一地点更改行为，而不是在事实和其他地方更改文档。 )