我们在任务列表中使用哪些标签(例如,Visual Studio 2008)
当前,在我们的代码中,我们使用以下标记,这些标记又可以在Visual Studio的任务列表中列出:
TODO标记代码中需要完成的任务
// TODO: optimize this loop
HACK标记仅可用于使当前工作(例如演示)的代码
// HACK: assume we know the users password to skip the need for a popup here
REVIEW标记已审核并需要进行一些编辑的部分代码
// REVIEW: the following method is redundant, use ABC.DEF() instead
已修复,以标记已修复的REVIEW代码段,以便审阅者可以看到已进行了适当的更改。
// REVIEW: the following method is redundant, use ABC.DEF() instead // FIXED: removed the method and updated the calls
我们在日常工作中还会使用哪些其他标签?我们认为使用标签(和任务列表)对于小型团队(最多10人)是否足够有效?我们还使用其他哪些方法直接注释部分代码?
解决方案
// SOYLENT:
我用它来标记需要设计更改的实际不良内容。
// I18N
我使用这一标记来标记具有硬编码字符串并需要更新为"多语言"多元文化的某些部分,我们稍后将对其进行回顾,并确保我们提取字符串或者正确格式的任何内容,并添加相应的"语言"调用。
我只使用TODO。它简化了生活,它们仅在开发过程中存在。一旦实施,便将其删除。 HACK真的是TODO戴着的帽子,对吧?
我没有将其余的代码放入代码中,因为我让Subversion管理我的差异,而Mantis管理我的待办事项。如果有人想将我之前所做的与现在在代码中所做的进行比较,则DIFF可以很好地实现这一点。
只是我的观点。不过,这是一个好问题。
我只使用TODO,但是团队中的每个开发人员都有一个不同的TODO,因此我们知道哪些问题是我们的(例如,对于Nick's To Do,我会得到NTODO)。
我还使用HACK作为关键字,但更多用于搜索,例如
int thisID = list[0].ID; // hack, assume list found a match
诸如此类的东西。
我使用TODO来指示需要更改或者添加的代码,并列出仍需要完成的功能或者代码,因为它经常被遗忘。
我使用HACK定义何时使用要更改的代码或者进行硬编码的代码。这也表明在实施之前我需要做更多研究的领域。
我们使用TODO [Initials] [Date],这有助于使人们对其待办事项负责。