Question

是否有Visual Studio 2010扩展程序允许您插入注释并自动附加您的用户名和当前日期：

// You type comments here [by Toni, on 03/26/2011]

这将有助于我们在我们的解决方案中保持统一的评论格式。

编辑：这个问题与VCS无关，我知道您可以在那里添加和执行评论。我只是在寻找Visual Studio 2010客户端解决方案！

Answer 1

这应该由您的版本控制系统处理，因为它更像是代码元数据而不是代码本身。将其留在代码中可能会比从VCS中获取更多麻烦，以防有人更新评论但忘记更新作者。大多数现代VCS都有blame命令（see SVN blame for example），它将显示该注释行的修订版和作者。

Answer 2

我倾向于同意snowbear跟踪谁在源代码控制中编写了什么代码。如果出于某种原因让你的小组更有意义在代码中添加注释，那么你可能只需创建一个visual studio宏并将其绑定到一个热键即可。以下内容应该足够了：

Sub TaggedComment()
    DTE.ActiveDocument.Selection.Text = "//   [by "
    DTE.ActiveDocument.Selection.Text = Environment.UserName
    DTE.ActiveDocument.Selection.Text = ", on "
    DTE.ActiveDocument.Selection.Text = DateTime.Now.Date.ToShortDateString
    DTE.ActiveDocument.Selection.Text = "]"
    DTE.ActiveDocument.Selection.StartOfLine(vsStartOfLineOptions.vsStartOfLineOptionsFirstText)
    DTE.ActiveDocument.Selection.CharRight(False, 3)
End Sub

或者，您可以考虑创建一个Code Snippet（这似乎是更高效的解决方案）。

Answer 3

您是否在codeplex上查看了LogSubstPol？

我引用：

LogSubstPol是TFS签到策略其中插入了登记注释和其他关键字到你的来源代码，所以你可以跟踪即使您没有连接也会发生变化到TFS。它可以与之比较任何$ log $（和其他）替代品其他CVS系统。

否则，您可以编写自己的:-)它应该基于TFS签入策略的可扩展性，使用PolicyBase Class

扩展以将用户名和日期附加到Visual Studio 2010代码注释

3 个答案: