TCLEP009程序员开发手册.docx

SharePointCodingStandard编码规范的设定规则:编程语言和开发环境所要求必须遵守的。约定:不是语言的一部分,而是一种编码风格,最重要的是要有统一的标准。编码规范的作用规范化(公司的角度)企业文化的一种需要,统一的风格有助于提高公司产品质量,降低开发成本,而且提高了公司凝聚力,当所有人都接受并执行一个统一的规范时,也就相当于形成了一个统一的文化。专业化(个人的角度)提高工作效率的同时,统一的规范会提高代码质量,从而提高个人的专业素养。高效(工作的角度)开发:协同开发写程序的需要,在一个开发组里,执行统一规范会增加代码融合度,减少开发中的沟通成本。程序员可以了解任何代码,弄清程序的状况而无需去猜测某段代码在干什么。维护:编码规范使程序更易于维护,无论是本人还是同事都需要,统一的规范可以让每个人都能看懂别人的代码从而进行维护。减少bug:在一致的环境下,开发者可以减少出犯错的机会。编码风格最重要的两点可读性它是良好的编码风格最突出的表现。一致性它是良好的编码风格最重要的准则。编码规范详细设定在我们公司的使用中,以Microsoft推荐的编码标准为基准,结合本公司的实际情况和通用****惯设定了如下的规范。命名规则命名时的基准规则Pascal大写—所有单词第一个字母大写,其他字母小写。RestoreDocumentForSharepointCamel大写—除了第一个单词,后面所有单词第一个字母大写,其他字母小写。restoreDocumentForSharepoint总体规范标识符的长度应当符合“min-length&&max-information”原则。名字要有意义,用描述性的词语来命名,能通过名字知道它的功能(用于循环迭代的变量例外)。避免缩写。如果这样造成命名过长的话可以改在注释中。但是常见的首字母缩写可以使用。例如:SP、IE等名字中不要加下划线,除非特殊情况。不要和关键字冲突。不要通过大小写的不同来区分名字。Countcount在命名中禁止出现以个人名字命名的一切代码。禁止在代码的任何段落中出现脏话及不良用语。缩写词不要全部使用大写字母,无论如何,当遇到以下情况,你可以用首字母大写其余字母小写来代替全部使用大写字母的方法来表示缩写词。使用::GetHTMLStatistic. 类的命名规范用名词或名词短语命名类。lassFileStream{}不加任何类前缀。文件名和类名要匹配。对于类HelloWorld,。当类只用作其他类的基类时,以Base结尾。ClassCarBase接口的命名规范使用名词或名词短语,或者描述行为的形容词来命名接口。使用Pascal大写。ponent在接口名前加前缀I,以表示这个类型是一个接口。(注意例如,IdentityStore。)一对类/接口组合名称要相对应,两个名称的不同之处只是接口名前有一个I前缀。 ponent{} ponent:IComponent{}方法的命名规范通常每个方法和函数都是执行一个动作的,所以对它们的命名应该清楚的说明它们是做什么的:用CheckForErrors()代替ErrorCheck(),用DumpDataToFile()代替DataFile()。这么做也可以使功能和数据成为更可区分的物体。