摘要:
规范的编码风格不仅体现了一个人的技术水平,从某种意义上说也体现了一个企业的形象。好的、规范的编码风格,对于整个项目团队来说显得尤为重要。本系列文章对于“编码风格”的说明仅做参考,希望能对你有所帮助。 阅读全文
摘要:
“程序员、程序员”顾名思义就是来编程序的人员。他们和一般工作人员是一样的,都需要合作,可能为了一个大型项目程序会有十人以上或者百人以上甚至千人以上的团队公司在一起工作。编码规范使程序规范化,易懂化,才能更好的进行合作。
开发程序的软件很多。但是它们的检查方式全是检查语法,并没有规定变量命名以及方法的命名,所以注释是很必要的东西,不过如果你将变量命名的规范一些。 Java和C#里的命名是最接近自然语言的 缺点是名字太长,你不喜欢你的老板,但是你得从老板手里赚钱,这就是道理。
喜欢是一回事,赚钱是另外一回事,找既喜欢,又赚钱的事情做,太难了。命名其实是越长越好的,因为表意性很好,大家看了像看文章一样,一目了然。这样才会使得别人更加明白清晰的看清你写程序的思路。
很多人忌讳写长名字,主要原因,可能还是怕敲起来麻烦。现在我们在学校用的visual studio 2005其实有很方便的拷贝功能,事实上,我的变量名,函数名,都只敲一遍,以后全部是拷贝+粘贴。
这样还有一个好处,就是我写的代码,永远不会有笔误,不会因为我敲错一个字符而导 阅读全文
摘要:
2.1 列宽
代码列宽控制在110字符左右。
2.2 换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
1、在逗号后换行;
2、在操作符前换行;
3、规则1优先于规则2。
2.3 缩进
缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。 阅读全文
摘要:
3.1 注释概述
1、修改代码时,总是使代码周围的注释保持最新。
2、在每个例程的开始,提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.
3、避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释在公共制表位处对齐。
4 、避免杂乱的注释,如一整行星号。而是应该使用空白将注释同代码分开。
5 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮,但是难于维护。
6 、在部署发布之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。
7 、如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。
8 、在编写注释时使用完整的句子。注释应该阐明代码,而不应该增加多义性。
9 、在编写代码时就注释,因为以后很可能没有时间这样做。另外,如果有机会复 阅读全文
摘要:
4.1 每行声明数
一行只作一个声明,如
int level; //推荐
int size; //推荐
int x, y; //不推荐
4.2 初始化
建议在变量声明时就对其做初始化。 阅读全文
摘要:
5.1 命名概述
名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
命名原则是:
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称,如方面名 AnalyzeThis(),或者属性名 xxK8。这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的,如 Book.BookTitle。而是应该使用 Book.Title。
3、只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
4、在变量名中使用互补对,如 min/max、begin/end 和 open 阅读全文
摘要:
6.1 每行一个语句
每行最多包含一个语句。如
a++; //推荐
b--; //推荐
a++; b--; //不推荐
6.2 复合语句
复合语句是指包含"父语句{子语句;子语句;}"的语句,使用复合语句应遵循以下几点
1 、子语句要缩进。
2 、左花括号“{” 在复合语句父语句的下一行并与之对齐,单独成行。
3 、即使只有一条子语句要不要省略花括号“ {}”。 如
while (d + = s++)
{
n++;
} 阅读全文
摘要:
7.1 命名方法
控件名简写+英文描述,英文描述首字母大写 阅读全文
摘要:
代码格式检查使用微软内部代码检查工具 StyleCop 版本4.3.2.1,它会根据预定义的C#代码格式的最佳实践,对源代码进行检查,并给出不符合编码风格的错误提示(版本语言英文)。
8.1 检查分类
检查规则分为7个部分,分别是
“文档规则(Documentation Rules)”
“布局规则(LayoutRules)”
“可维护性规则(Maintanability Rules)”
“命名规则(Naming Rules)”
“代码顺序规则(Ordering Rules)”
“可读性规则(Readability Rules)”
“间距规则(Spacing Rules)” 阅读全文
摘要:
使用Visual Studio自身的代码分析功能,检查内容如下表,分为
1.安全规则。
2.互操作性规则
3.可维护性规则
4.可以只性规则
5.命名规则
6.全球化规则
7.设计规则
8.性能规则
9.移动性规则
10.用法规则
其中“是否检查”一项中为“√”的内容不能违反。需在Visual Studio中设置为错误 阅读全文
摘要:
信息系统项目管理系列之三:项目管理过程发布日期:2011年3月18日星期三作者:EricHu 说明:本文属作者的读书笔记。 勤能补拙、笨鸟先飞。 项目管理是一项整体的努力。项目管理的整体性要求每一个项目和产品过程同其他过程恰当地配合与联系起来,只有这样才便于协调。过程就是一组为了完成一系列事先... 阅读全文
摘要:
项目管理是一项整体的努力。项目管理的整体性要求每一个项目和产品过程同其他过程恰当地配合与联系起来,只有这样才便于协调。
过程就是一组为了完成一系列事先指定的产品、成果或服务而须执行的互相联系的行动和活动。
在项目管理领域,项目管理的五个项目过程组具有明确的依存关系并在各个项目中按一定的秩序执行。这五大过程组是: 阅读全文