Visual studio VisualStudio中的令牌:HACK、TODO。。。还有别的吗?
在VisualStudio中,您发现哪些令牌有用? (visual studio 2010)→ 环境→ 任务列表→ 代币) 目前我只有:Visual studio VisualStudio中的令牌:HACK、TODO。。。还有别的吗?,visual-studio,configuration,token,Visual Studio,Configuration,Token,在VisualStudio中,您发现哪些令牌有用? (visual studio 2010)→ 环境→ 任务列表→ 代币) 目前我只有: 黑客攻击-低 审查-高 待办事项-正常 WTF-高 (仅这些-删除了一些默认值) 您是否在使用其他软件? 您是否用评论标记涵盖了其他重要内容? 有什么最佳实践吗?thnx另一个内置的是NOTE。以下是我使用的: 待办事项:功能尚未实现 FIXME:应该修改/重构代码以实现某些目标(更高的可维护性、更好的性能等等) 错误:代码有一个已知的错误 Vim会自动
- 黑客攻击-低
- 审查-高
- 待办事项-正常
- WTF-高
有什么最佳实践吗?thnx另一个内置的是NOTE。以下是我使用的:
- 待办事项:功能尚未实现
- FIXME:应该修改/重构代码以实现某些目标(更高的可维护性、更好的性能等等)
- 错误:代码有一个已知的错误
- Vim会自动突出显示
XXX
,这恰好是我选择的标记,以便于键入
可以这样说:
在注释中使用XXX
来标记虚假但有效的内容。使用FIXME
标记伪造和损坏的内容
我已经组合了上面的大部分标记
RED: code that simply does not work / compile
// Error - This code is throwing a specific reproducible error.
// Broken - This code is broken and will not run.
// WTF - WHAT THE FRIG.
ORANGE: code that works but is not right
// Hack - This code has intentionally been hacked in order to work. Should not go into production.
// FixMe - This code works but could be better. Needs better abstraction, maintainability, performance, etc.
// Bug - This code works and was expected to be right but a bug has been found. (usually flagged post production)
// Review - This code is probably right but should be reviewed for piece of mind.
// Smells - Same as FixMe
BLUE: code that works but either needs more features or more explaining
// Todo - Functionality is not yet implemented
// Note - Better explain what's going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane.
我喜欢删除标记,这表明它只用于测试,不应该包含在最终版本中是的,我不喜欢它,因为任何注释都不是注释吗?同意,但除了注释之外,我尽量不使用任何注释。如果我还有别的东西,它会进入追踪系统。在我的例子中,JIRA.ah,我明白了,我更多地使用注释:PI不太喜欢旧的绿色墨水:)注意:不仅更改默认注释颜色,还可以在todo窗格中为注释提供配置文件。我喜欢fixme和bug:)我使用hack for fixme。将添加错误!我使用相同的:)--我为我的FIXME做子标记,即:FIXME-Performance.Yup。还有待办事项-翻译。我们使用Mantis#123来参考我们的错误跟踪系统和相应的数字。关于vim的好提示。我不知道。可能是社区wiki。对于在visual studio中查找任务列表标记的用户,请注意菜单命令是visual studio→ 工具→ 选择权→ 环境→ 任务列表→ 代币我不一定使用所有这些,但取决于我那天的心情,我会以这样或那样的方式突出显示。如果贵公司的所有员工都突出显示相同的代币,这是一件很酷的事情。如果不是,在某些情况下,它只会使注释更难理解。功能是如何实现的?代码是如何工作的?这是一种非常糟糕的做法。如果代码用于测试,则将条件编译与预处理器指令一起使用。@AMissico但是
//REMOVE
更容易