Coding
来源:互联网 发布:苹果手机应用数据删除 编辑:程序博客网 时间:2024/04/30 01:53
Simplicity
Just getting code to work is not good enough, because the first solution you come up with is hardly ever the simplest possible solution. Your methods may be too long, which makes them harder to test. You may have duplicated functionality, or you may have tightly coupled classes. Complex code is hard to understand and hard to modify, because every little change may break something else in the system. As a system grows, complexity can become overwhelming to the point where your only remaining option is to start over.
When compared to beginners, expert programmers typically implement superior solutions using fewer lines of code. This is a hint that simplicity is harder than complexity, and takes time to master.
Simple code is self-documenting because you pick meaningful names, your methods are concise, and your classes have clearly defined responsibilities. Simple code is hard to achieve, and relies on knowledge in the areas of object-oriented programming, design patterns, and other facets of software engineering.
Comments
If code is self-documenting, do you need source code comments? In short, there will always be cases where you need comments, but you should never write comments simply for the sake of commenting. If the meaning of a method is completely obvious, you do not need a comment. An abundance of comments in code is often an indication that the code is unclear and in need of refactoring. Let's look at a method that needs a comment, and see how to eliminate this need.
/** * Sets the value of x. * @param x the horizontal position in pixels. */public void setX(int x) { this.x = x;}
This method needs a comment because the meaning of "x" is not entirely clear. Over time, the comment might not be kept in sync if someone changes the method's implementation or signature. But what if we rename things to make the code more clear? How about this:
public void setXPixelPosition(int xPixelPosition) { this.xPixelPosition = xPixelPosition;}
This code no longer needs a comment because it is self-documenting. As a result, we end up typing a little bit more for the method declaration, but save a few lines of comments. This helps us out in the long run because we don't have to spend time and effort keeping the comment in sync with the code.
References: Java eXtreme Programming Cookbook. O'Reilly
- Coding
- Coding
- coding
- coding
- coding
- coding
- Coding
- coding
- Coding
- Coding
- coding
- coding
- coding coding
- coding coding coding 感悟
- Coding,coding and even more coding
- Coding 如何使用 Coding 开发 Coding
- Coding References
- Coding standards
- Java 程序编码规范
- 戒烟进入第5天!
- 匈牙利命名法
- 建立数据库结构的两种方法
- 数据库命名约定 --- 数据库结构命名
- Coding
- 关于数组的插入与删除以及排序
- 未来技术走向和Delphi前景(个人意见)
- 数据库的备份于恢复
- C 编程最佳实践
- 文件加解密
- asp.net窗体的打开和关闭
- 龟兔赛跑的小游戏
- 密码