TODO对开发人员来说是一个棘手的主题。许多代码库都让TODO挥之不去,而没有人知道谁负责TODO,甚至没有人知道解决它所需的上下文。然而,我们应该为挥之不去的TODO感到羞耻吗?许多开发人员已采用将TODO添加到其项目代码中的方法。但是,这不一定是管理它们的最佳方法。本文将介绍软件工程师组织TODO的4种方式。TODO提取到集中式界面更有意义,该界面允许您主动管理它们并添加元数据,例如上下文、功能描述、要求,甚至相关代码片段。
软件工程师组织TODO的4种方式
这些指南并不是管理TODO的确切规则手册,因为它取决于您团队的偏好、规模和管理风格。因此,这里列出了四个技巧,可帮助您更好地管理团队的待办事项。
1.使用TODO解决小问题
软件工程师应该只使用TODO来定义任何团队成员都可以快速处理的微任务。例如,您可以添加一个TODO来提醒开发人员将模块的名称更改为更具描述性的名称。在项目管理工具中,这不是一项需要单独工单的任务。
更大的问题或任务需要使用项目管理工具。它允许您定义问题的规范并将其作为开发冲刺的一部分进行规划。
2.添加足够的上下文
仅在代码库中添加TODO并不是引发代码问题的最佳方式。如果您正在寻找组织问题和添加上下文的方法,请尝试Stepsize。它允许工程师将他们的TODO导入平台,组织它们并添加上下文,例如链接代码、依赖项并添加指标。
3.对TODO使用一致的格式
TODO的一致格式使您可以更好地管理它们。例如,您可以选择定义截止日期和所有者的格式。
当您拥有一致的格式时,在代码审查期间接受符合定义格式的TODO会容易得多。它可以防止您的团队在您的项目中出现模棱两可的TODO。最重要的是,固定格式允许您快速搜索代码库中的TODO。
4.为TODO定义规则
与您的团队坐在一起为TODO制定规则。例如,定义允许使用TODO的任务类型。通过澄清这一点,识别微任务与需要项目管理工具帮助的任务要容易得多。
上述就是关于软件工程师组织TODO的4种方式的全部内容,想了解更多关于软件研发的信息,请继续关注中培伟业。