《团队-科学计算器-代码设计规范》

Posted 2020-10-08 伤心的一池秋水

代码布局设计

缩进

　　1.Tab实现

　　2.空格实现

　　

字符串：

　　1.单引号

　　2.双引号

　　3.避免反斜杠的出现。

 

1 、变量名称
　　在写变量的时候，尽量避免小写的l和大写字母O和大写字母I，主要原因是容易和数字中1,0相混淆

2 、包和模块名称
　　模块尽量使用简短的全部小写的名称，如果可以增加可读性那么可以使用下划线，python的包不推荐使用下划线，但是在引用其他语言写的扩展包中可以使用下划线来表示区分

3 、类名称
　　类名称主要遵循为CapWords约定，表示为首字母大写

4、异常名称

　　异常归于类，从而也要遵循类名的规范，主要是在后缀上必须添加“Error“

5全局变量名
　　全局变量只在模块类有效，和function命名相同

6、方法名称
　　方法名称全部为小写，下划线是可选的（在增加可读性的基础上使用）

7、方法变量
　　类的方法第一个参数总是self

　　类方法的静态变量总是为crs

　　如果一个方法的参数和保留字相冲突，那么在后面添加下划线进行区分

8、常量
　　常量命名全部使用大写，可以使用下划线进行分割

注释

　　在修改的代码的时候，务必修改注释。

　　注释必须是英文，最好是完整的句子，首字母大写

　　分别为：行注释，块注释，文档注释

android代码规范

代码：

1. Activity 命名一律使用 模块名+Activity 的方式。例如，LoginActivity、SignupActivity；
2. Fragment 命名一律使用 模块名+Fragment 的方式；
3. 自定义View：Custom(建议)+功能名+View/ViewGroup(具体的组件名称)。例如：CustomImageScroller、CustomRatingBar。
4. Widget 小组件：ScanWidget、WeatherWidget。
5. Dialog对话框：功能名+Dialog。例如：LoginDialog、ProgressDialog
6. 尽量在每一个Activity或类中加入TAG,方便我们查看Activity的信息，这里Android Studio提供了快捷方式logt方式即可快速生成当前类的常量。
7. 对于使用Intent传递数据，声明一些Key的时候：
8. 增加类注释，使用Android Studio的 File And Code Template：
9. 所有的常量加上注释，且功能相同的排放在一起，不同的进行换行；
10. Activity中变量采用m开头+类名。例如，mTable、mPerson；
11. Activity中的控件：m+模块名+控件类型名称。例如，mLoginEditText,mLoginTextView

     

资源Res

　　1.按照资源的类型，分为以下几种

　　　　控件Id命名：控件缩写 _模块（module) _功能名(function)

　　2.Color资源命名