如何提升代码的可读性

1、先写注释，再写代码；理清思路再动手

（1）清晰的思路是编程行动的良好指南

花点时间思考一下，不要一接到任务就动手编代码，从而陷入技术细节不可自拔

 

（2）理清思路后，在空白处填写自己的代码

如果某个步骤中实现起来感觉有点麻烦，那就先放一个空的子函数，为这个子函数建一个空的函数体——保证编译始终通过，稍后再填充这个空函数体。这种方法不影响你的整体思路，避免陷入编程细节，同时又让“大事化小，小事化了”。

（3）编完主函数后，填充空的子函数体

通过主函数的运行效果，可以实时检测子函数编写的正确与否。我们编写的子函数都即时被应用场景所调用，也就是即时的被测试，这不也是测试驱动的思想吗？事实证明，这样得到的函数，比预先设计的函数更有用。这样，只要思路清晰正确，编程就不会走太大弯路。

 

 

2、.给变量起个好名字

合理的变量命名是代码可读的基础。好的命名，不仅仅是使得代码易读，它代表了你对业务领域的理解，对程序逻辑的认知，对项目框架的把握。所以，好的程序员很多时候纠结的不是技术实现问题，而是如何为变量起一个好名字，使得代码读起来流畅，能让更多的人理解！

遵循一些成熟的命名规范，给变量起个好名字的事会容易一些。接下来，我们探讨一下常见的命名规范问题。

（1）常见的大小写命名法：

PascalCasing（大写开头）：用于名字空间、类型、成员等的命名，举例：FileStream。

camelCasing（驼峰命名法，小写开头）：用于形参、局部变量、私有字段等的命名。举例ToInt32(string value)。

匈牙利命名法（小写开头，首单词为数据类型）：不推荐使用，因为IDE的智能提示很容易让你知道变量的类型。举例：intCount、iCount。

另外，微软建议不要在单词间使用下划线。

（2）名字空间的命名

<Company>.(<Product>|<Technology>)[.<Feature>][.<Subnamespace>]

 

 

 

3、如何检测你的代码是否规范

（1）人工检测：让同伴阅读你的代码（结对编程，代码复审），发现问题。自我检测，不懈追求――“让人阅读你的代码，就像阅读文章一样流畅！”。

（2）工具检测：FxCop，微软的一个开发工具，可以对编译过的托管代码进行分析，并告诉用户哪些地方不符合设计规范。

 

 

 

参考资料：   如何提高代码可读性     http://www.studyofnet.com/news/438.html