注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

学会珍惜

You've been saying for the longest time

 
 
 

日志

 
 

自文档化的程序   

2012-12-08 23:05:38|  分类: 持续集成 |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |
数据处理的基本原理告诉我们,试图努力维持不同文件之间的同步关系,是一件非常费力不讨好的事情。更合理的方法是:每个数据项包含两个文件都需要的所有信息,采用指定的键值来区别,并把它们组合到一个文件中。
不过,我们在程序文档编制的实践中却违反了自己的原则。典型地,我们试图维护一份机器可读的程序以及一系列包含记叙性文字和流程图的人类可读性文档。
耶稣门徒彼得说“为什么要把我们的祖宗和我们所不能负的轭放在门徒的颈项上呢?”(《使徒行传》15:10)。文档是我们和前人都不曾成功背负的重担。作为基本目标,我们必须试图把它的负担降到最小。
创建自文档化程序(Self- Documenting):把文档整合到源程序,正确输出程序,保证编程用户能方便、及时地得到文档资料。具体到前端实践,给出的解决方案是:采用构建类工具如ant+js-doc可以初步完成程序和API文档的输出。
  评论这张
 
阅读(73)| 评论(0)
推荐

历史上的今天

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017