知识卡片
与其逐行读完全部代码找线索,不如写个脚本专门扫描TODO和FIXME这类"开发者留给自己的提醒"
用脚本扫描代码库中的TODO、FIXME等开发注释,可低成本聚合被遗忘的待办与已知问题,避免人工逐行读大规模代码。把扫描结果接入缺陷或项目跟踪系统能提高可见度;标记只是待核实线索,仍要确认是否过期、是否已解决及其实际风险。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第17章 高效测试之美 · 查看原书依据
环境都会在代码中间自动地插入"TODO"关键词来提醒开发者需要在此做一些后继的代码工作。然而,在有些情况下,这些需要“做某事”的地方经常会被开发者疏忽而忘记了去“做某事”。代码在提交的时候通常会把"TODO"等关键词一并提交到代码服务器上。这些待完成的代码积少成多,就会成为影响软件开发进程的风险。
参考来源
- 位置:《测试之美》第17章《高效测试之美》(源文件:extracted/程序之美系列套装(6册)团队之美、项目管理之美、架构之美、数据之美、测试之美、安全之美/_epub-src/OEBPS/Text/part0562.xhtml)
- 结论依据:原文指出这些标记可能随代码一同提交并逐渐被遗忘,自动扫描聚合后提高团队可见度;因此卡片同时保留“线索需核实”的限制。
- 原始内容:环境都会在代码中间自动地插入"TODO"关键词来提醒开发者需要在此做一些后继的代码工作。然而,在有些情况下,这些需要“做某事”的地方经常会被开发者疏忽而忘记了去“做某事”。代码在提交的时候通常会把"TODO"等关键词一并提交到代码服务器上。这些待完成的代码积少成多,就会成为影响软件开发进程的风险。 FIXME(以及类似的注释) FIXME是一个似于TODO的关键词,通常它是表明此处的代码存在的问题已经被测试人员发现并且需要修复。我所见过的"FIXME"关键词出现的地方,有简单的(如“应该有个更好的变量名”),也有复杂的(如“这一部分代码存在严重问题,此处功能须重新设计”)。 TODO和FIXME都是非常实用的关键词。在整个开发小组中,这类关键词需要更加高的可见度。你可以将这些关键词的检查加入到bug、问题跟踪以及项目管理系统中以提高小组对这些关键词的重视程度。 [1]http://en.wikipedia.org/wiki/Cross-site_scripting. [2]http://en.wikipedia.org/wiki/SQL_inje