Расширение для добавления имени пользователя и даты в комментарии кода Visual Studio 2010 - PullRequest
3 голосов
/ 27 марта 2011

Существует ли расширение Visual Studio 2010, которое позволит вам добавлять комментарии и автоматически добавлять ваше имя пользователя и текущую дату:

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

Это помогло бы нам поддерживать единый формат комментариев в нашем решении.

Редактировать : Этот вопрос не о VCS, я знаю, что вы можете добавлять и применять комментарии там. Я просто ищу решения для Visual Studio 2010 Client только!

Ответы [ 3 ]

10 голосов
/ 27 марта 2011

Это должно обрабатываться вашей системой контроля версий, так как это больше метаданные кода, чем сам код. Оставив его в коде, вы столкнетесь с большими трудностями, чем с VCS, если кто-то обновит комментарий, но забудет обновить автора. Большинство современных VCS имеют команду blame ( см. Вину SVN, например, ), которая покажет ревизию и автора этой строки комментария.

3 голосов
/ 29 марта 2011

Я склонен согласиться с Snowbear в том, что отслеживание того, кто написал, какой код принадлежит в управлении исходным кодом. Если по какой-либо причине для вашей группы имеет больше смысла оставлять комментарии в коде, то вам, вероятно, не удастся просто создать визуальный студийный макрос и связать его с горячей клавишей. Что-то вроде следующего должно быть достаточно:

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 (что представляется наиболее эффективным решением).

0 голосов
/ 29 марта 2011

Вы смотрели на LogSubstPol на codeplex?

Цитирую:

LogSubstPol - это политика регистрации TFS. который вставляет комментарии регистрации и другие ключевые слова в ваш источник код, так что вы можете отслеживать меняется, даже если вы не подключены в TFS. Это можно сравнить с $ log $ (и другие) подстановки в любом другие системы CVS.

В противном случае вы можете написать свой собственный :-) Он должен основываться на расширяемости политики регистрации TFS, используя PolicyBase Class

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...