如何编写易于理解和使用的程序代码
让代码简短
一个好的程序代码一定要是清晰易懂的。程序只写一次，但以后会有无数次的阅读，因此，编写出好用的程序代码是很重要的。其中一个关键点就是让代码简短。
不要小看这一点，很多人都忽视它，这是不对的。你写的方法要始终能在一个屏幕里放得下，如果你需要去滚动屏幕，这会分散你的注意力，而且你看不到整个的上下文。最佳长度是5-20行，这根据你的情况而定。
避免使用神秘数字
当你要把什么东西跟一个常量值做比较时，记得把这个值定义成常量。没有什么会比去猜测你的同事写的这样的代码更让人头疼的事了。例如，将`il lt; 4384`换成`inputLength lt; MAX_INPUT_LENGTH`会更加清晰易懂。
使用自描述的变量名和方法名
设计出来的代码要做到：无论是谁，只要看一眼就能知道是干嘛的。尽量不要用简写方式，除非有特殊的习惯。例如，`src - source`, `pos - position`, `prev - previous`这样的简写方式相比于`numTeamMembers, seatCount, numSeatsInStadium`更难理解。
如果你认为描述性的名称并不是那么有价值，请对比一下`n, ns, nsisd`和`numTeamMembers, seatCount, numSeatsInStadium`。
遵循语言习俗约定
每种语言都有自己不同的习俗约定。一般来说，人们听的最多的是Java的编码规范。
让我们看看其中的一些习俗规范：
- 方法名应该小写字母开头，其后用字母大写的单词连接（例如`veryLongVariableName`）；
- 类名应该都使用首字母大写的单词连接而成；
- 常量名应该全部大写，用下划线连接（例如`MY_CONSTANT`）；
- 左大括号应该跟if语句在同一行。
只有在有必要的理由时才去打破这些常规，不要轻易的因为你不高兴就违反它。如果你只是在团队里改变一些这样的习惯，那也没问题，但当把你代码拿出来和其他的没有这些思想准备的程序员共享时，问题就会来了。
版权声明：本文内容由互联网用户自发贡献，本站不承担相关法律责任.如有侵权/违法内容,本站将立刻删除。
