到底要不要写注释

提问

到底要不要写注释

回答

内部代码尽量少写注释
原因
1.再完美的注释也无法解释糟糕的代码
2.注释不会随着重构变更

公开API代码高尽量写完善注释
原因
可以利用注释生成API文档