Comment


为方便交流及后期维护,要求为每行代码添加注释,除非此行源代码 (或上下文逻辑) 很简单而无必要添加外。

出于商业目的或保密性要求,发布 APP 时可将某些源代码注释移除。 Recommend use File Comment 小程序快速批量删除源代码注释。

 

1. Basic Requirement


注释必须简短、扼要,能完整体现源代码作用-特性,且不会产生歧义;当然,可使用缩写字符 (譬如 FTS 表示 Full Text Search) 及多语种混合。

 

2. Single Line Comment


Python 单行注释以 # 字符开头。

C/C++ 单行注释以 // 字符开头。

 

3. Multi-line Comment


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

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