摘要:
今天终于把这一系列的编码规范写完了,这个编码规范算上前面阅读相关书籍,前前后后总共花了一个月的时间,也算是个人的呕心沥血之作了。本来也没打算把这个系列写的这么长,但是在写的过程中自己搜了相关的网上资料,后来发现网上的c#代码规范很少,而且仅有的几份都很泛泛,没有实际的内容。所以自己就阅读了相关的书籍... 阅读全文
摘要:
格式格式的统一使用可以使代码清晰、美观、方便阅读。为了不影响编码效率,在此只作如下规定:长度一个文件最好不要超过500行(除IDE自动生成的类)。一个文件必须只有一个命名空间,严禁将多个命名空间放在一个文件里。一个文件最好只有一个类。如果超过500行,考虑拆分类或者使用Partial 类将类按照功能... 阅读全文
摘要:
本文是读完前言中提到的几本书后,结合自身的想法总结出来的如何写好注释的一些比较实用的方法。另外本文是上一篇 注释篇 的一个补充如何写好注释避免使用不明确的代词有些情况下,"it", "this"等代词指代很容易产生歧义,最安全的方式是不要使用将所有可能产生歧义的代词替换成实际指代的词。如://Ins... 阅读全文
摘要:
注释注释毫无疑问是让别人以最快速度了解你代码的最快途径,但写注释的目的绝不仅仅是"解释代码做了什么",更重要的尽量帮助代码阅读者对代码了解的和作者一样多。当你写代码时,你脑海里会有很多有价值的信息,但当其他人读你代码时,这些信息已经丢失,他们所见到的只是眼前代码。注释约定如果IDE提供注释格式,则尽... 阅读全文
摘要:
最近在为公司编写c#编码规范,以前对这方面研究不多,只是觉得代码能够出自己的意思就可以了。我参考了以下资料C# Coding ConventionsNET设计规范约定惯用法与模式(第2版)编写可读性代码的艺术重构—改善既有代码的设计高效程序员的45个习惯代码整洁之道发现其实真要写好一个代码规范是一件... 阅读全文
摘要:
特定场景下的命名最佳实践命名空间要使用PascalCasing,并用点号来分隔名字空间中的各个部分。如Microsof.Office.PowerPoint要用公司名作为命名空间的前缀,这样就可以避免与另外一家公司使用相同的名字。要用稳定的,与版本无关的产品名称作为命名空间的第二层不要使用公司的组织架... 阅读全文
摘要:
上一篇文章讲了标识符命名的约定,今天讲下标识符命名的选择。简单的讲,看到一个标识符一定要可以见名知意。名字一定要能够表达出标识符的含意标识符名字必须要表达出该标识符的意义,绝对不可以使用无意义的v1,v2…vn之类的命名。 public static void CloneChars(char[] c... 阅读全文
摘要:
c#编码规范 阅读全文