本文档的建立是为了适应团队开发和开发流程的统一,增加代码的强壮性、可读性和易维护性,让新的开发人员能迅速适应项目氛围。
1.每行代码最多不得操作100个字。
函数方法超过100字的,将参数换行对齐处理,如图示:
字符串变量如果超过100个字,用 + 号组织,如图示:
2. 空行的使用
import块后空1行
变量声明后需要空1行,如果需要分类区别,各类别之间空1行。
条件、循环,选择语句,整个语句结束,需要空1行。
各功能块之间空1行。
注释与代码之间不空行。
3. 注释的使用
当你需要时,使用注释来解释一段特定的代码段的作用。注释必须保证更新或者及时删除。
单行注释用///
多行注释用/** …… */
多行注释中按以下格式写, 方便用代码各处可以用option+click查看。
/**
注释描述
- Parameter 参数名1: 参数1说明
- Parameter 参数名2: 参数2说明
*/
效果如下图示: