注释风格影响代码可读性

冗余的注释就等于涂鸦

对比

最佳实践

注释不应当用于说明算法
注释只应当用于说明算法的某一个部分
意图不属于算法
总说比分说好/Conclusion is better than declusion.

参考《程序设计实践》