在代码编辑中,经常会遇到变量名和一行代码过长的情况,总结如下,希望有帮助。
命名规则
1.命名
-
标识符要清晰、明了,有明确含义,同时使用完整的单词,或者大家基本理解的缩写,避免产生误解——尽量采用英文单词。
-
若使用英文单词和中文混合定义,使用连字符“_”割开。
-
较短单词通过去掉“元音”形成缩写;例如:temp->tmp、flag->flg、statistic->stat、increment->inc、message->msg等
-
较长的单词可取单词的头几个字母形成缩写;
-
-
命名中使用的特殊约定或缩写,要注释说明。
-
命名规范必须与所使用的系统风格保持一致,在同一项目统一。
- 本人使用的是驼峰法命名:
函数名:PrintPayData();
类中属性:_printData;
类中字段:PrintData;
函数形参和局部变量:printData
const/satatic变量:PrintData
控件命名:botton -_btnConnect; label - _lblData; textbox -_txtData;
属性:使用名词、名词短语或形容词
布尔属性前加“Is”,“Can”,"Has"前缀
- 本人使用的是驼峰法命名:
-
对于变量命名,禁止取单个字符(如i 、j 、k… ),建议除了要有具体含义外,还要表明变量类型、数据类型等,但i 、j 、k 作局部循环变量是允许的。
2. 编程单词缩写规则: -
大于2个单词则采用缩写规则,否则不用缩写。
-
缩写的规则采用国际惯用方法:
- 元音字母剔除法,首字母除外。使用单词的头一个或几个字母。
-
组合单词元音缩写:
-
应以剔除法、截头法为基本方法,在此基础上使用“典型词组合法:
-
使用变量名中有典型意义的单词。如Count of Failure写成FailCnt。
-
去掉无用的单词后缀 ing, ed等。如Paging Request写成PagReq。
-
3. 长表达式如何分行:
(超过120列)要在低优先级操作符处换行,换行注意要与第一个条件对齐。
说明:
1、在逗号后换行。
2、在低优先级操作符前换行。
3、1优先2
```csharp
if ((iFormat == ZH_A_Format_M) &&
(iOfficeType == ZH_BSC_M)) // 条件表达式的续行在第一个条件处对齐
{
TestSomething();
}
for (long_initialization_statement;
long_condiction_statement; // for循环语句续行在初始化条件语句处对齐
long_update_statement)
{
TestSomething();
}
// 函数声明的续行在第一个参数处对齐
BYTE ReportStatusZHeckPara(BYTE ucCallNo,
BYTE ucStatusReportNo);
// 赋值语句的续行应在赋值号处对齐
fTotalTotle = fTotalTotle + faCustomerPurZHases[iID]
+ fSalesTax(faCustomerPurZHases[iID]);
-
参考文章:
https://blog.youkuaiyun.com/jiangjunjie_2005/article/details/23130891
https://blog.youkuaiyun.com/New_new_zero/article/details/79046107
https://blog.youkuaiyun.com/haizhongyun/article/details/8131847
http://www.cnblogs.com/wfwenchao/p/5209197.htm