3.9 缩写
某些通用的缩写可以使用,如:
temp 可缩写为 tmp ;
message 可缩写为 msg ;
3.10 标识符命名中应注意的问题
3.10.1 除局部循环变量外变量名禁止取单个字符
对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
说明:变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。
3.10.2 不用数字定义名字
除非必要,不要用数字或较奇怪的字符来定义标识符。
示例:如下命名,使人产生疑惑。
void set_sls00( BYTE sls );
应改为有意义的单词命名
void setUdtMsgSls( BYTE sls );
3.10.3 用正确的反义词组命名
用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
说明:下面是一些在软件中常用的反义词组。
1 add / remove begin / end create / destroy 2 insert / delete first / last get / set 3 increment / decrement put / get add / delete 4 lock / unlock open / close min / max 5 old / new start / stop next / previous 6 source / target show / hide send / receive 7 source / destination cut / paste up / down 8 9 示例: 10 int minSum; 11 int maxSum; 12 int addUser( BYTE *userName ); 13 int deleteUser( BYTE *userName );
3.10.4 避免使用
应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。
4 样式
4.1 Java 文件样式
所有的 Java(*.java) 文件都必须遵守如下的样式规则
4.1.1 版权信息
版权信息必须在 java 文件的开头,示例:
1 /* 2 * ------------------------------------------------------- 3 * Copyright (c) 2018, 小a玖拾柒 4 * All rights reserved. 5 * 6 * FileName:filename.java 7 * Description:简要描述本文件的内容 8 * History: 9 * Date Author Desc 10 * ------------------------------------------------------- 11 */