1,共用规范
1,命名规范
1,常量
名称全部大写,用下划线来连接单词。
2,变量
小驼峰命名,前缀应当是名词。
- Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo
- Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo
3, 函数
小驼峰命名,前缀应当是动词
4, 类&构造函数
大驼峰命名,
5,类的成员
1,公共属性和方法
与变量和函数的命名方法一样。
2,私有属性和方法、
前缀为_,其余的和公共的相同
2,注释规范
1,行内注释
与代码处于同一行
2,单行注释
3,多行注释
/*
* 代码执行到这里后会调用setTitle()函数
* setTitle():设置title的值
*/
setTitle();
函数(方法)注释也是多行注释的一种,有特殊的注释要求。
/**
* 函数说明
* @关键字
*/
常用函数注释关键字:
- @param @param 参数名 {参数类型} 描述信息
- @return @return {返回类型} 描述信息
- @author @author 作者信息