在团队及项目开发过程中,需要标准的文档化规范。具备良好的软件文档的同时,也要有良好的编码标准、规范及指南,它并不仅仅包含了编码的内容,还有编码的最佳实践和编码如何文档化的最佳实践。良好的编码规范及指南,可以从源头(编码阶段)上扼制缺陷的注入,提高代码品质的同时,也降低了维护成本。同时,良好的代码品质也是代码可复用技术的基础。总而言之,采用良好、完整的代码规范,通过对规范、指南的剪裁获得适合项目过程的编码规约是每个项目开场的重头戏,希望下面这些可供参考的标准、规范、指南能为大家带来帮助。
1.Microsoft’s All-In-One Code Framework Coding Guideline(中、英)
微软的一站式示例编码指南,最难得的是有中文版本,涵盖了规约和最佳实践。
http://1code.codeplex.com/wikipage?title=All-In-One%20Code%20Framework%20Coding%20Standards&referringTitle=Documentation
2.IDesign C# Coding Standards
IDesign的资源不仅仅包括这个C#编码标准,还有WCF编码标准、Web服务方法颗粒度标准等,在编码和设计方面都不失为良好的参考标准。
http://www.idesign.net/
3.Encodo C# Handbook
http://archive.msdn.microsoft.com/encodocsharphandbook/Release/ProjectReleases.aspx?ReleaseId=3352
4. Microsoft Framework Design Guidelines
微软的类库设计指南,关于接口设计和类库设计的一些指导性意见和建议,是基础类库开发者的首选参考。
http://msdn.microsoft.com/en-us/library/ms229042.aspx
5.Denni’s C# Coding Standards Document
http://csharpguidelines.codeplex.com/
6.Brad’s Quick Post on Microsoft Internal Coding Guidelines
http://blogs.msdn.com/b/brada/archive/2005/01/26/361363.aspx
7.Mike Kruegar’s C# Coding Style Guide
想必深入了解.NET的开发者都应该知道SharpDevelop,此标准就是SharpDevelop的开发者在过程中应用的编码样式指南,是良好的实践标准。
http://www.icsharpcode.net/
8.Lance Hunt’s C# Coding Standards Document
http://weblogs.asp.net/lhunt/pages/CSharp-Coding-Standards-document.aspx
9.Coding Guidelines by Aviva Solutions
http://csharpguidelines.codeplex.com/releases/view/46280
10.Philips Healthcare – C# Coding Standards
这是Philips Healthcare产品的编码指南,可供业界软件开发参考。
http://www.tiobe.com/content/paperinfo/gemrcsharpcs.pdf
11..NET/SQL/TFS Code & Application Design by SSW
SSW的指南并不仅仅包括编码指南,还有数据库设计、配置库管理及应用程序设计等诸多内容,可参考性很强。
http://www.ssw.com.au/ssw/standards/default.aspx
12.C# Coding Guidelines by Validio Software
软件产品的编码规范。
http://www.nrjetix.com/fileadmin/doc/publications/additional_info/CSharp_Coding_Guidelines.pdf
13.C# Coding Standards and Best Programming Practices by DotnetSpider
http://www.dotnetspider.com/tutorials/bestpractices.aspx
14.《Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (2nd Edition)》
中文版名称为《.NET设计规范:.NET约定、惯用法与模式》,是类库设计及开发人员不可或缺的参考手册。