为方便交流及维护，要求尽可能为每行代码添加注释，除源代码 (或上下文逻辑) 简单无必要添加外。

出于商业或保密性要求，发布 APP 时可移除某些 (或全部) 源代码注释。

推荐使用 文件注释 小程序，快速批量删除源代码注释。

1. 基本要求

注释必须简短、扼要，能体现源代码的作用、特点、或上下文关系，且不会产生歧义。

可以使用缩写字符 (譬如 FTS 表示 Full Text Search)，或多语种 (譬如：中文 + 英文) 混合注释代码。

2. 单行注释

---

Python 单行注释从 # 字符 开始。

最好转义 Python 源代码中的 # 字符 。

C/C++ 单行注释从 // 字符 开始。

3. 多行注释

---

C/C++ 语言 /* */ 字符 间内容，为多行注释。

Python 语言 """ 或 ''' 字符 间内容，为多行注释。

内容表

1. 基本要求
2. 单行注释
3. 多行注释

上一话题

保留关键词

下一话题

提示信息

快速搜索