项目Alpha冲刺——代码规范、任务及计划

最新推荐文章于 2024-11-02 21:22:43 发布

转载最新推荐文章于 2024-11-02 21:22:43 发布 · 94 阅读

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/XuanZhengZhangGuan/p/10765703.html

本文详细阐述了项目开发过程中的代码规范，包括类名、变量名、常量名的命名规则，以及资源文件的命名建议。同时，文章还提供了一个为期十天的项目开发计划，涵盖了从熟悉开发环境到功能完善的所有阶段。

【强制】类名使用 UpperCamelCase 风格
【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格
【参考】局部变量允许使用a, b简单的命名，但尽量使用类名中出现的字母(一眼看上去能知道)，数组遍历允许使用 i, j 等简单的命名
- 例：Context c; Database db;
- 反例：Context i;
【强制】常量命名全部大写，单词间用下划线隔开
【强制】res资源文件（图片等）及HTML表单name命名全部小写，单词间用下划线隔开
- 例：activity_main.xml
【推荐】资源文件及组件ID的命名力求不混淆，可以考虑给名字加上所属的Activity前缀等
- 例1：@+id/main_activity_login_button
- 例2：login_button_state_ok.xml
【参考】各组员实现的功能接口要有注释描述，或在讨论时说明其的功能（输入和输出，有没有正确性判断），注释方式随意
【参考】方法内部，使用注释和空行来分隔成小段，注释描述下方代码段的功能
- 例:
- //以下是打开文件
- File f=new file()
- //以下是读数据
- for(){
- log.d("");
- log.d("");
- log.d("");
- }
- //以下收尾
- f.close();
【强制】没实现的地方必须加TODO，写上署名，最好包括上描述
-例： //TODO MK 这个部分改天做

其他不常用标准尽量按照：
阿里巴巴规约

转载于:https://www.cnblogs.com/XuanZhengZhangGuan/p/10765703.html