说明脚本的内容

Question

我在脚本顶部有一个描述，告诉读者脚本的功能。我怎么称呼这个描述？一个规格？如何在函数定义上方对函数的操作进行描述？我会称这个功能的规格吗？谢谢。

Answer 1

这取决于描述的正式程度以及编程语言。我会把它称为“描述”，“文档”，“评论”，或者（如果使用像javadoc或doxygen这样的东西）“文档注释”。

某些编程语言对此有特定的用语。例如，在Python中，有一种特定的机制来记录模块或函数，这将被描述为“docstring”。