#关于文档与注释#
1.一直觉得代码才是最好的注释。
从代码规范,架构,命名等角度入手,创造业内形成共识的代码,不仅可读,同时还具备鲁棒性,扩展性等优点。
减少走钢丝的骚操作。比如指针的套娃,位移操作内存,高级语言开发者,就应该做"高级"的事,"低级"行为会增加负担。
2.注释和文档的维护,实际上成本极高。即使是大厂的开源项目,也经常能看到,代码与文档注释不一致,更别说公司内部项目了,进而形成误导。要是代码规范都做不好,更别说维护文档注释了。分分钟被文档注释骗得妈都不认识。
3.以代码设计为基础,文档做架构/项目描述,代码中难以避免的临时方案等添加适当注释。