當程式中用到一些辨別符(像max_number_of_entries),并且需要一份正式文檔時,該文檔需要列出所有的常量,并說明它們的含義。在程式中添加注釋來描述這些常量将有助于了解代碼,并有助于生成文檔。
有些工具可以從代碼中提取出常量的注釋,下面給出了常量注釋的例子:
當程式中用到一些辨別符(像max_number_of_entries),并且需要一份正式文檔時,該文檔需要列出所有的常量,并說明它們的含義。在程式中添加注釋來描述這些常量将有助于了解代碼,并有助于生成文檔。
有些工具可以從代碼中提取出常量的注釋,下面給出了常量注釋的例子: