注釋


為方便交流及後期維護,要求為每行代碼添加注釋,除非此行源代碼 (或上下文邏輯) 很簡單而無必要添加外。

齣於商業目的或保密性要求,發布 APP 時可將某些源代碼注釋移除。 推薦使用 文件注釋 小程序快速批量刪除源代碼注釋。

 

1. 基本要求


注釋必須簡短、扼要,能完整體現源代碼作用-特性,且不會産生歧義;當然,可使用縮寫字符 (譬如 FTS 錶示 Full Text Search) 及多語種混閤。

 

2. 單行注釋


Python 單行注釋以 # 字符開頭。

C/C++ 單行注釋以 // 字符開頭。

 

3. 多行注釋


C/C++ 語言 /* */ 字符間內容,為多行注釋。

Python 語言 """ 或 ''' 字符間內容,為多行注釋。