代码整洁之道-3 如何写注释

这只是推荐规则，要根据实际情况去抉择。

1. 代码可以被持续不断的维护，但是注释很难做到这一点。随着时间的推移，注释的意思会出现偏差和错误，所以不推荐写太多的注释。
2. 别给糟糕的代码加注释了，重写吧(如果可以的话)。
3. 可以用注释写一些警告，防止不了解代码的新手做一些很容易出现的错误做法。
4. 在函数头部用标准格式做注释是比较好的做法，容易维护(例如javadoc)。
5. 注释也不是要必须省略掉，若过注释可以帮助你省去读具体算法等东西，那就加上吧。不过一般函数名称都可以做到这一点。
6. 注释掉的代码最好说明其注释原因或者干脆删掉，不然没有人敢动被注释的代码。
7. 用代码替换掉注释，例如：

//用于判断是不是一个好苹果
if (apple.color == "red" && apple.weight > 10)
{ ... }
//可以替换成：
if (apple.isHighQuality)
{ ... }

还有这，省略注释的同时分开异常处理部分

public void startSending()
{
	try { doSending() }
	catch (SocketException e)
	{ /*正常，发送被人为终止*/ }
	catch (Exception e
	{
		//add exception and close response
		response.add(ErrorResponder.makeExcetionString(e));
		response.clossAll();
	}
}

可以改成这样：

public void startSending()
{
	try { doSending() }
	catch (SocketException e)
	{ /*正常，发送被人为终止*/ }
	catch (Exception e
	{ addExceptionAndCloseResponse(e); }
}