為方便交流及維護，要求盡可能為每行代碼添加注釋，除源代碼 (或上下文邏輯) 簡單無必要添加外。

齣於商業或保密性要求，發布 APP 時可移除某些 (或全部) 源代碼注釋。

推薦使用 文件注釋 小程序，快速批量刪除源代碼注釋。

1. 基本要求

注釋必須簡短、扼要，能體現源代碼的作用、特點、或上下文關係，且不會産生歧義。

可以使用縮寫字符 (譬如 FTS 錶示 Full Text Search)，或多語種 (譬如：中文 + 英文) 混閤注釋代碼。

2. 單行注釋

---

Python 單行注釋從 # 字符 開始。

最好轉義 Python 源代碼中的 # 字符 。

C/C++ 單行注釋從 // 字符 開始。

3. 多行注釋

---

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

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

內容錶

1. 基本要求
2. 單行注釋
3. 多行注釋

上一話題

保留關鍵詞

下一話題

提示信息

快速搜索