Skip to content

Latest commit

 

History

History
58 lines (22 loc) · 1.32 KB

约定.md

File metadata and controls

58 lines (22 loc) · 1.32 KB

约定

1.变量名/参数名

2.注释规范

3.待解决问题

变量名/参数名

变量名必须详细,不要出现相似容易混淆的取名方式

如果变量名比较长用'_'来间隔

参数名:放在参数表的参数名一律小写,没有放在参数表中,即一般不怎么该或不方便该的参数全部大写,并在最后加上‘__’例如:COUNT_ _

变量名的提前约定:

frame/image:分别表示单帧图像与单张图像,都是255RGB通道,本质上没什么区别

thresh :都表示二值图像 mask:掩膜

gray:灰度图像

注释规范

注释写中文

每个函数都应该包含注释(''' XXX '''),包括对于输入和输出变量的解释以及实现功能的描述。

可以的话尽量详细描述

每个定义的参数都应该 有描述,如果是放在参数表中的参数可以在参数表中描述,如果不是放在参数表中的参数,应在其上或后加上# XXXX

待解决问题

如果是函数待解决问题,应该在函数的注释中用 TODO解释

如果不是单个函数问题,应该在程序文件附带的‘待解决问题.txt’中进行表述

表述过程应该精确到某个模块的行。如果是整体结构性问题则不许精确到行