c书写规范
ReadyGo!技术成就梦想
www.efish.cn
efish
2007-10-25 10:14:33
一、命名
对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用 getnextstudent()，而不是 getnextarrayelement()。
命名原则是：
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、方法、属性、变量规范
ⷦnbsp; 避免容易被主观解释的难懂的名称，如方面名 analyzethis()，或者属性名 xxk8。这样的名称会导致多义性。
ⷦnbsp; 在面向对象的语言中，在类属性的名称中包含类名是多余的，如 book.booktitle。而是应该使用 book.title。
ⷦnbsp; 使用动词-名词的方法来命名对给定对象执行特定操作的例程，如 calculateinvoicetotal()。
ⷦnbsp; 在允许函数重载的语言中，所有重载都应该执行相似的函数。
ⷦnbsp; 只要合适，在变量名的末尾或开头加计算限定符（avg、sum、min、max、index）。
ⷦnbsp; 在变量名中使用互补对，如 min/max、begin/end 和 open/close。
ⷦnbsp; 鉴于大多数名称都是通过连接若干单词构造的，请使用大小写混合的格式以简化它们的阅读。另外，为了帮助区分变量和例程，请对例程名称使用 pascal 大小写处理 (calculateinvoicetotal)，其中每个单词的第一个字母都是大写的。对于变量名，请使用 camel 大小写处理 (documentformattype)，其中除了第一个单词外每个单词的第一个字母都是大写的。
ⷦnbsp; 布尔变量名应该包含 is，这意味着 yes/no 或 true/false 值，如 fileisfound。
ⷦnbsp; 在命名状态变量时，避免使用诸如 flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentflag，而是使用更具描述性的名称，如 documentformattype。 （此项只供参考）
ⷦnbsp; 即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。
ⷦnbsp; 可能的情况下，尽量不要使用原义数字或原义字符串，如 for i = 1 to 7。而是使用命名常数，如 for i = 1 to num_days_in_week 以便于维护和理解。
二、代码书写规范
格式化使代码的逻辑结构很明显。花时间确保源代码以一致的逻辑方式进行格式化，这对于您和你的开发小组，以及以后维护源代码的其他开发人员都有很大的帮助。
以下几点是推荐的格式化方法。
ⷦnbsp; 建立标准的缩进大小（如四个空格），并一致地使用此标准。用规定的缩进对齐代码节。
ⷦnbsp; 在发布源代码的硬拷贝版本时使用特定的字体以及字号（新宋体、小五号）。
ⷦnbsp; 在括号对对齐的位置垂直对齐左括号和右括号，如：
for (i = 0; i < 100; i++)
{
;
}
也可以使用倾斜样式，即左括号出现在行尾，右括号出现在行首，如：
for (i = 0; i < 100; i++){
;
}
无论选择哪种样式，请在整个源代码中使用那个样式。
ⷦnbsp; 沿逻辑结构行缩进代码。没有缩进，代码将变得难以理解，如：
if(expression )
{
//
//此处填写你的代码块;
//
}
if(expression )
{
//
//此处填写你的代码块;
//
}
else
{
//
//此处填写你的代码块;
//
}
缩进
对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用 getnextstudent()，而不是 getnextarrayelement()。
命名原则是：
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、方法、属性、变量规范
ⷦnbsp; 避免容易被主观解释的难懂的名称，如方面名 analyzethis()，或者属性名 xxk8。这样的名称会导致多义性。
ⷦnbsp; 在面向对象的语言中，在类属性的名称中包含类名是多余的，如 book.booktitle。而是应该使用 book.title。
ⷦnbsp; 使用动词-名词的方法来命名对给定对象执行特定操作的例程，如 calculateinvoicetotal()。
ⷦnbsp; 在允许函数重载的语言中，所有重载都应该执行相似的函数。
ⷦnbsp; 只要合适，在变量名的末尾或开头加计算限定符（avg、sum、min、max、index）。
ⷦnbsp; 在变量名中使用互补对，如 min/max、begin/end 和 open/close。
ⷦnbsp; 鉴于大多数名称都是通过连接若干单词构造的，请使用大小写混合的格式以简化它们的阅读。另外，为了帮助区分变量和例程，请对例程名称使用 pascal 大小写处理 (calculateinvoicetotal)，其中每个单词的第一个字母都是大写的。对于变量名，请使用 camel 大小写处理 (documentformattype)，其中除了第一个单词外每个单词的第一个字母都是大写的。
ⷦnbsp; 布尔变量名应该包含 is，这意味着 yes/no 或 true/false 值，如 fileisfound。
ⷦnbsp; 在命名状态变量时，避免使用诸如 flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentflag，而是使用更具描述性的名称，如 documentformattype。 （此项只供参考）
ⷦnbsp; 即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。
ⷦnbsp; 可能的情况下，尽量不要使用原义数字或原义字符串，如 for i = 1 to 7。而是使用命名常数，如 for i = 1 to num_days_in_week 以便于维护和理解。
二、代码书写规范
格式化使代码的逻辑结构很明显。花时间确保源代码以一致的逻辑方式进行格式化，这对于您和你的开发小组，以及以后维护源代码的其他开发人员都有很大的帮助。
以下几点是推荐的格式化方法。
ⷦnbsp; 建立标准的缩进大小（如四个空格），并一致地使用此标准。用规定的缩进对齐代码节。
ⷦnbsp; 在发布源代码的硬拷贝版本时使用特定的字体以及字号（新宋体、小五号）。
ⷦnbsp; 在括号对对齐的位置垂直对齐左括号和右括号，如：
for (i = 0; i < 100; i++)
{
;
}
也可以使用倾斜样式，即左括号出现在行尾，右括号出现在行首，如：
for (i = 0; i < 100; i++){
;
}
无论选择哪种样式，请在整个源代码中使用那个样式。
ⷦnbsp; 沿逻辑结构行缩进代码。没有缩进，代码将变得难以理解，如：
if(expression )
{
//
//此处填写你的代码块;
//
}
if(expression )
{
//
//此处填写你的代码块;
//
}
else
{
//
//此处填写你的代码块;
//
}
缩进
2秒记住本站域名
玩过泡泡龙吗？Readygo?Go! 再加上.Com.Cn的后缀，那就是大名小顶的ReadyGo.com.cn