西西河

主题:【原创】尴尬除虫记 -- 懒厨

共:💬19 🌺25
全看树展主题 · 分页首页 上页
/ 2
下页 末页
家园 理论上说。源码本身写的足够好是不需要写什么注释。

如果使用好的库,好的命名方式,源码段之间承接的逻辑关系(模块划分)清晰。那的确是不需要什么注释了。

写库(函数库)和接口是另一回事。那得写文档,光注释也不行。

家园 有些算法,当初写的时候

很明白,很技巧,但没有注释。

过几个月自己看看,都很难理解,陌生得很。其他人看就不用说了。

这时候就后悔当初怎不写点注释呢?事半功倍的事情。

家园 呵呵。如果是写算法就相当与写库了

既然是写库。那当然是要写注释和文档的。

我写代码都把这些东西抽出来。测试过以后。统统放到namespace kit下,黑箱黑箱。

家园 好习惯。
全看树展主题 · 分页首页 上页
/ 2
下页 末页


有趣有益,互惠互利;开阔视野,博采众长。
虚拟的网络,真实的人。天南地北客,相逢皆朋友

Copyright © cchere 西西河