文档代码同源

目录 1、问题起源 2、解决方案 2.1、需求和代码对应 2.2、每日检查 2.3、飞行检查 2.4、公共模块 3、补充说明 4、遗留问题 文档代码同源,故名思意,就是文档和代码都写在源代码文件里。这样可以:1.修改代码的时候就及时修改文档,使得文档和代码及时保持一致;2.阅读代码时,增加代码的可读性。评审代码的时候,尤其是修改时后,即对文档一同评审。结合研发流程、评审的配合,可促使代码、文档的开
相关文章
相关标签/搜索