主题:【原创】尴尬除虫记 -- 懒厨
共:💬19 🌺25
如果使用好的库,好的命名方式,源码段之间承接的逻辑关系(模块划分)清晰。那的确是不需要什么注释了。
写库(函数库)和接口是另一回事。那得写文档,光注释也不行。
很明白,很技巧,但没有注释。
过几个月自己看看,都很难理解,陌生得很。其他人看就不用说了。
这时候就后悔当初怎不写点注释呢?事半功倍的事情。
既然是写库。那当然是要写注释和文档的。
我写代码都把这些东西抽出来。测试过以后。统统放到namespace kit下,黑箱黑箱。
如果使用好的库,好的命名方式,源码段之间承接的逻辑关系(模块划分)清晰。那的确是不需要什么注释了。
写库(函数库)和接口是另一回事。那得写文档,光注释也不行。
很明白,很技巧,但没有注释。
过几个月自己看看,都很难理解,陌生得很。其他人看就不用说了。
这时候就后悔当初怎不写点注释呢?事半功倍的事情。
既然是写库。那当然是要写注释和文档的。
我写代码都把这些东西抽出来。测试过以后。统统放到namespace kit下,黑箱黑箱。