新版程序员开发基础手册

SharePointCodingStandard编码规范设定规则：编程语言和开发环境所 规定 关于下班后关闭电源的规定党章中关于入党时间的规定公务员考核规定下载规定办法文件下载宁波关于闷顶的规定 必要遵守。商定：不是语言一某些，而是一种编码风格，最重要是要有统一原则。编码规范作用规范化（公司角度）公司文化一种需要，统一风格有助于提高公司产品质量，减少开发成本，并且提高了公司凝聚力，当所有人都接受并执行一种统一规范时，也就相称于形成了一种统一文化。专业化（个人角度）提高工作效率同步，统一规范会提高代码质量，从而提高个人专业素养。高效　（工作角度）开发：协同开发写程序需要，在一种开发组里，执行统一规范会增长代码融合度，减少开发中沟通成本。程序员可以理解任何代码，弄清程序状况而无需去猜测某段代码在干什么。维护：编码规范使程序更易于维护，无论是本人还是同事都需要，统一规范可以让每个人都能看懂别人代码从而进行维护。减少bug：在一致环境下，开发者可以减少出出错机会。编码风格最重要两点可读性它是良好编码风格最突出体现。一致性它是良好编码风格最重要准则。编码规范详细设定在咱们公司使用中，以Microsoft推荐编码原则为基准，结合我司实际状况和通用习惯设定了如下规范。命名规则命名时基准规则Pascal大写—所有单词第一种字母大写，其她字母小写。RestoreDocumentForSharepointCamel大写—除了第一种单词，背面所有单词第一种字母大写，其她字母小写。restoreDocumentForSharepoint总体规范标记符长度应当符合“min-length&&max-information”原则。名字要故意义，用描述性词语来命名，能通过名字懂得它功能（用于循环迭代变量例外）。避免缩写。如果这样导致命名过长话可以改在注释中。但是常用首字母缩写可以使用。例如：SP、IE等名字中不要加下划线，除非特殊状况。不要和核心字冲突。不要通过大小写不同来区别名字。Countcount在命名中禁止浮现以个人名字命名一切代码。禁止在代码任何段落中浮现脏话及不良用语。缩写词不要所有使用大写字母，无论如何，当遇到如下状况，你可以用首字母大写别的字母小写来代替所有使用大写字母办法来表达缩写词。使用：GetHtmlStatistic.不使用：GetHTMLStatistic.类命名规范用名词或名词短语命名类。使用Pascal大写publicclassFileStream{}不加任何类前缀。文献名和类名要匹配。对于类HelloWorld,相应类文献名也应为HelloWorld.cs。当类只用作其她类基类时，以Base结尾。ClassCarBase接口命名规范使用名词或名词短语，或者描述行为形容词来命名接口。使用Pascal大写。ICarComponent在接口名前加前缀I，以表达这个类型是一种接口。（注意例如，IdentityStore。）一对类/接口组合名称要相相应，两个名称不同之处只是接口名前有一种I前缀。 publicinterfaceIComponent{} publicclassComponent：IComponent{}办法命名规范普通每个办法和函数都是执行一种动作，因此对它们命名应当清晰阐明它们是做什么：用CheckForErrors()代替ErrorCheck()，用DumpDataToFile()代替DataFile()。这样做也可以使功能和数据成为更可区别物体。用动词或动词短语命名办法。使用Pascal大写。RemoveAll()。变量命名规范局部变量和办法参数：使用Camel大小写形式。 inttotalCount=0;成员变量：沿用VC规范，m开头，其后用Pascal大写。privateintmTotalCount=0；静态变量：以s开头，其后用Pascal大写。staticintsTotalCount;常量命名规范常量每一种字母都应当大写。constintSYSTEMID=100；conststringSYSTEMNAME=“TestM”;属性命名规范用名词或名词短语命名。用Pascal大写命名属性。成员变量与其属性差别只在于第一种字母m。成员变量mWebName相应属性WebName属性与变量类型要统一。命名空间命名规范用Pascal大写命名。使用故意义名字定义命名空间，如产品名或者公司名。把System系列命名空间组织到一起放上面，第三方提供命名空间放到系统命名空间下面。为每一种命名空间创立一种 目录 工贸企业有限空间作业目录特种设备作业人员作业种类与目录特种设备作业人员目录1类医疗器械目录高值医用耗材参考目录 ，这样可以更容易地将命名空间映射到目录层次划分。用MyProject/TestSuite/TestTier作为MyProject.TestSuite.TestTier途径。咱们公司命名空间以xxx开头，例如：xxx.Migrator格式化规范这里大某些格式规范都可以用VS自动化格式功能实现。缩进用TAB，不用SPACES。对与最大缩进层数，并没有一种固定规矩，如果缩进层数不不大于四或者五层时候，你可以考虑着将其代码因数分解。在每个运算符先后都空一格。用一种空行来分开代码逻辑分组。在一种类中，各个办法需用一空行，也只能是一空行分开。花括号{}需和括号外代码对齐。每个花括号需独立一行。If、for、while、do等语句自占一行，无论执行语句多少都要加“{}”很长程序行应当进行拆分。当一行被分为几行时，通过将串联运算符放在每一行末尾而不是开头，清晰地表达没有背面行是不完整。每一行上放置语句避免超过一条。在逗号后换行。在操作符后换行。在高层换行而不要在低层处换行。折行后对齐上一行语句同一层表达式起始位置。构造 设计 领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计 规范 工程 路基工程安全技术交底工程项目施工成本控制工程量增项单年度零星工程技术标正投影法基本原理 设计规范各个project输出途径要一致，普通状况下是”..\..\bin\Release\”.在各个工程文献里把应用到dll所属project都应用进来，这样可以保证应用不会出错。所有目录下都需要具备README文档，其中涉及：该目录功能及其包括内容，一种对每一文献在线阐明（带有link），每一种阐明普通还应当提取文献标头某些属性名字。涉及设立、使用阐明，指引人民如何连接有关资源：源文献索引、在线文档、纸文档、设计文档、其她对读者有协助东西。考虑一下，当每个原有开发人员走了，在6个月之内来一种新人，那个孤单探险者通过阅读阐明文献，源文献标头阐明等等，就应当有能力维护整个工程。文献名命名规范模块名称、输出文献名称、二进制文献名称应当由部长或组长制定，并且需要符合公司这方面规定。（前缀带公司名缩写、不要空格等）产品名称.环境信息名称.主功能名称.[子功能名称.[子功能名称…]].exe，例如：xxx.yy.Backup.Browser.exe/dll/wsp，不容许使用下划线，空格等。单词首字母大写。避免浮现AaBbBb这样命名方式。类文献编写规范避免在同一种文献中放置各种类。避免使用大文献。如果一种文献里代码超过1000行，必要考虑将代码分开到不同类中，并且要有效运用好region。在最接近一种局部变量被使用地方声明该局部变量。在定义变量（或参数）时，要将修饰符*和＆紧靠变量名。重要类构造public，protected，private顺序在所有程序中应保持一致。程序中不要浮现名字相似局部变量和成员变量。代码文献保存需要保存成utf-8格式。在保存新文献时选取File->AdvancedSavedOptions，再选取Unicode(UTF-8…).办法编写规范避免写太长办法。如果一种办法代码超过５０行，应当考虑按不同操作将其分解为不同办法，这样各个功能可以很容易被重用，并且各个办法内代码变化也很容易理解。上限为200行。一种办法只完毕一种任务。不要把各种任务组合到一种办法中，虽然那些任务非常小。避免写超过5个参数办法。如果要传递各种参数，要使用构造来完毕。避免使用诸多成员变量。应当声明局部变量，并传递给办法。不要在办法间共享成员变量。否则很难懂得是哪个办法在什么时候修改了它值。参数命名、顺序合理。如果使用类型和数目不拟定参数，需要特殊注意并在注释中写明白其用途。不要省略了函数返回值类型。函数名字与返回值类型在语义上不要冲突。不要将正常值和错误标志混在一起返回，正常值应当用输出参数获得，而错误标志用return语句返回。重要一行代码应当只做一件事，如只定义一种变量，只写一条语句。如果代码行中运算符比较多，要用括号清晰地拟定表达式操作顺序。不要编写太复杂或者多用途复合表达式,复杂表达式不能表白设计者技术更好，只会带来维护上困难。常量使用含义直观常量来表达那些将在程序中多次浮现数字或字符串。如果某一常量与其他常量密切有关，要定义中包括了这种关系。变量变量初始化或缺省值要精确，应当在任何状况下都不引起错误。变量使用时注意上溢或下溢。变量使用时注意精度。对一种数值变量采用不是0，-1，1等惯用数值初始化时，给出选取该值理由。别把成员变量声明为public或protected。普通声明为private而使用public/protectedProperties。数据类型变量数据类型应当符合其定义。减少并谨慎使用不同数据类型之间赋值，避免精度损失或者赋值后类型错误。不要进行不同数据类型比较，除非特殊状况。尽量使用C#特有类型，而不是System命名空间中定义别名类型。好：intage；stringname；objectcontactInfo;不好：Int16age；Stringname；ObjectcontactInfo;逻辑判断要注意精度因素导致比较无效问题。要注意表达式中优先级与否对的。逻辑判断成果要符合常规，不要颠倒。字符串比较时要注意大小写，如果不大小写敏感时要使用，Name.Equals(excludeItem.Name，StringComparison.OrdinalIgnoreCase)不要用隐含错误方式写if语句?例如：（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。（2）将浮点变量用“==”或“！=”与任何数字比较。（3）将指针变量用“==”或“！=”与NULL比较。总是将恒量放在等号/不等号左边，例如：if(6==$errorNum)...一种因素是如果你在等式中漏了一种等号，语法检查器会为你报错。第二个因素是你能立即找到数值，而不是在你表达式末端找到它。需要一点时间来习惯这个格式，但是它的确很有用。循环问题如果循环体内存在逻辑判断，并且循环次数很大，要将逻辑判断移到循环体外面。要注意循环终结条件与否对的谨慎使用无法正常终结（死循环）循环。在循环里不要错误地修改循环变量。要注意误差累积对成果影响。Case语句结尾要加break。写switch时要加default分支。defaultcase总应当存在，它应当不被到达，然而如果到达了就会触发一种错误。Switch中如果你要创立一种变量，那就把所有代码放在块中。Case0:{inti=0;}Continue和break其实是变相隐蔽goto办法，要谨慎使用。Mutex管理在使用前充分结识Mutex，例如：Mutex应当在finally{}里释放(否则异常状况会导致Mutex释放操作被跳过)注意释放Mutex有时会引起异常。请确认Mutex在线程或者进程结束前被释放。(在正常 流程 快递问题件怎么处理流程河南自建厂房流程下载关于规范招聘需求审批流程制作流程表下载邮件下载流程设计 中，应当避免杀死线程和进程操作，这样操作也许会导致释放操作被忽视)使用Mutex前看与否必要，Mutex应当被用于多进程中同步，如果仅仅是同步一种进程中线程，可以用lock{}代替。如果必要使用Mutex,请确认与否恰当控制好了有关code。普通状况下，应当在短操作中使用同步对象(Mutex,lock)(在一种没有复杂操作办法中)其她规范总是使用接口。避免只有一种成员接口，努力保证一种接口有3~5个成员。当使用抽象类时候，提供一种接口。内存管理SQL对象使用结束后一定要关闭：(例)Reader.Close()；某些对象与否在list中保持应用，而事实上不再使用也要及时释放。申请大内存对象后，使用完毕要释放，如果频繁使用，可以考虑重用。异常解决加try－catch时注意，一定要在catch里加解决语句，千万不要catch里啥也不做，那样效果还不如不加try－catch了。如果你能确认在catch里不需要输出，那就加个注释，阐明这里不需要输出。try{sr.Close();}catch{//Doesnotrequireoutput}解决异常基本逻辑是：对于严重问题（备份或者创立site失败、连接数据库失败等），应当在捕获异常后结束job，注意输出错误信息。对于非严重问题（备份还原单项目失败、还原某个属性失败等），可以在捕获异常后输出错误信息，然后继续向下执行。捕获异常后，重新写自己异常，这个时候一定要把原先异常信息涉及到新异常里。在异常中包括某些非常重要信息。举一种例子，咱们代码经常要判断与否有足够磁盘空间。当磁盘空间局限性是，咱们只输出磁盘空间局限性，并没有写哪个地方磁盘空间局限性，当前多少空间，咱们需要多少空间，等等。例子：long(realSize