java开发

1 明确的告诉代码做了什么
coffeeShop.PlaceOrder(2);  这个2到底是什么呢 ？不知道。
如果这样呢
public enum CoffeeCupSize
{
Small,
Medium,
Large
}
接下来就可以用它来下单要咖啡了。
coffeeShop.PlaceOrder(CoffeeCupSize.Largxe);  这样做就更加的清晰

2代码要清晰的表现出意图
public int compute(int val)
{
int result = val << 1;
//... more code ...
  return result;
}
第 3 行中的位移操作符是用来干什么的？如果善于进行位运算，或者熟悉逻辑设计或汇编编程，就会明白我们所做的只是把 val 的值乘以 2 。  但是这违背了PIE原则
PIE 原则
所写的代码必须明确表达你的意图，而且必须富有表现力。这样可以让代码更易于被别人阅读和理解。代码不让人迷惑，也就减少了发生潜在错误的可能。代码要清晰地表达意图。

所以 result = val * 2 是更好的

3要编写清晰的而不是讨巧的代码 ，向代码阅读者明确表明你的意图。可读性差的代码一点都不聪明。
应该让自己或团队的其他任何人，可以读懂自己一年前写的代码，而且只读一遍就知道它的运行机制。

4记录问题解决日志
面对问题（并解决它们）是开发人员的一种生活方式。当问题发生时，我们希望赶紧把它解决掉。如果一个熟悉的问题再次发生，我们会希望记起第一次是如何解决的，而且希望下次能够更快地把它搞定。然而，有时一个问题看起来跟以前遇到的完全一样，但是我们却不记得是如何修复的了。这种状况时常发生

可以选择符合需求的任何格式。下面这些条目可能会用得上。
• 问题发生日期。
• 问题简述。
• 解决方案详细描述。
• 引用文章或网址，以提供更多细节或相关信息。
• 任何代码片段、设置或对话框的截屏，只要它们是解决方案的一部分，或者可以帮助更深入地理解相关细节。

5警告就是错误
即使代码编译时产生了警告，我们还是可以运行程序。那么忽略警告信息继续开发代码，会导致什么状况呢？这样做等于是坐在了一个嘀嗒作响的定时炸。弹上，而且它很有可能在最糟糕的时刻爆炸。
一个关于未被使用的变量的警告，可能不会产生什么恶劣影响，但却有可能是暗示某些变量被错误使用了。而这个被误用的变量会带来什么可怕后果就值得深思了。
6 使用明确的错误信息
像“无法找到文件”这样的错误信息，就其本身而言无助于问题的解决。“无法打开 /andy/project/main.yaml 以供读取”这样的信息更有效