描述，告訴腳本做什麼

Question

我在腳本的頂部有一個說明，告訴讀者腳本做了什麼。我會將這種描述稱爲什麼？規格？位於函數定義之上的函數操作描述如何？我會爲該功能調用一個規範嗎？謝謝。

Answer 1

這取決於描述的正式程度以及編程語言。我將其稱爲「描述」，「文檔」，「評論」或（如果使用諸如javadoc或doxygen之類的）「文檔評論」。

一些編程語言對此有特定的術語。例如，在Python中，有一個特定的機制來記錄將被描述爲「文檔字符串」的模塊或函數。