新版程序员开发基础手册.docVIP

SharePoint Coding Standard 编码规范设定 规则：编程语言和开发环境所要求必需遵守。 约定：不是语言一部分，而是一个编码风格，最关键是要有统一标准。 编码规范作用 规范化（企业角度） 企业文化一个需要，统一风格有利于提升企业产品质量，降低开发成本，而且提升了企业凝聚力，当全部些人全部接收并实施一个统一规范时，也就相当于形成了一个统一文化。 专业化（个人角度） 提升工作效率同时，统一规范会提升代码质量，从而提升个人专业素养。 高效　（工作角度） 开发：协同开发写程序需要，在一个开发组里，实施统一规范会增加代码融合度，降低开发中沟通成本。程序员能够了解任何代码，搞清程序情况而无需去猜测某段代码在干什么。 维护：编码规范使程序更易于维护，不管是本人还是同事全部需要，统一规范能够让每个人全部能看懂她人代码从而进行维护。 降低bug：在一致环境下，开发者能够降低出犯错机会。 编码风格最关键两点 可读性 它是良好编码风格最突出表现。 一致性 它是良好编码风格最关键准则。 编码规范具体设定 在我们企业使用中，以Microsoft推荐编码标准为基准，结合本企业实际情况和通用习惯设定了以下规范。 命名规则 命名时基准规则 Pascal大写—全部单词第一个字母大写，其它字母小写。 RestoreDocumentForSharepoint Camel大写—除了第一个单词，后面全部单词第一个字母大写，其它字母小写。 restoreDocumentForSharepoint 总体规范 标识符长度应该符合“min-length max-information”标准。 名字要有意义，用描述性词语来命名，能经过名字知道它功效（用于循环迭代变量例外）。 避免缩写。假如这么造成命名过长话能够改在注释中。不过常见首字母缩写能够使用。比如：SP、IE等 名字中不要加下划线，除非特殊情况。 不要和关键字冲突。 不要经过大小写不一样来区分名字。Count count 在命名中严禁出现以个人名字命名一切代码。 严禁在代码任何段落中出现脏话及不良用语。 缩写词不要全部使用大写字母，不管怎样，当碰到以下情况，你能够用首字母大写其它字母小写来替换全部使用大写字母方法来表示缩写词。 使用: GetHtmlStatistic. 不使用: GetHTMLStatistic. 类命名规范 用名词或名词短语命名类。 使用Pascal大写public class FileStream {} 不加任何类前缀。 文件名和类名要匹配。对于类HelloWorld,对应类文件名也应为 HelloWorld.cs。 当类只用作其它类基类时，以Base结尾。Class CarBase 接口命名规范 使用名词或名词短语，或描述行为形容词来命名接口。 使用Pascal大写。ICarComponent 在接口名前加前缀I，以表示这个类型是一个接口。（注意比如，IdentityStore。） 一对类/接口组合名称要相对应，两个名称不一样之处只是接口名前有一个I前缀。? public interface IComponent {}? public class Component : IComponent{} 方法命名规范 通常每个方法和函数全部是实施一个动作，所以对它们命名应该清楚说明它们是做什么：用CheckForErrors()替换ErrorCheck()，用DumpDataToFile()替换DataFile()。这么做也能够使功效和数据成为更可区分物体。 用动词或动词短语命名方法。 使用Pascal大写。RemoveAll()。 变量命名规范 局部变量和方法参数：使用Camel 大小写形式。?int totalCount = 0; 组员变量：沿用VC规范，m开头，其后用Pascal大写。 private int mTotalCount = 0; 静态变量：以s开头，其后用Pascal大写。static int sTotalCount; 常量命名规范 常量每一个字母全部应该大写。 const int SYSTEMID = 100; const string SYSTEMNAME = “TestM”; 属性命名规范 用名词或名词短语命名。 用Pascal大写命名属性。组员变量和其属性差异只在于第一个字母m。 组员变量mWebName 对应属性WebName 属性和变量类型要统一。 命名空间命名规范 用Pascal大写命名。 使用有意义名字定义命名空间，如产品名或企业名 。把System系列命名空间组织到一起放上面，第三方提供命名空间放到系统命名空间下面。 为每一个命名空间创建一个目录，这么能够更轻易地将命名