StackQ Ответов: 1

Уникальный способ добавить комментарий в vb и c#, который будет включать добавленную/отредактированную дату, цель и имя разработчика


это очень простой вопрос-
вот кто-то прокомментировал это так

1st format
'added on-06-12-2012
'By-xyz
'Remarks: For Cancel button click event.
or
2nd format
'Addedby-XYZ ON 06-12-2012 For Cancel button click event.

Private Sub BttnCancel_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles BttnCancel.Click
            ActionCancel()
            ActionClose()
End Sub


поэтому я просто хочу узнать больше формата для комментариев.Bcoz этот тип комментариев используется большинством людей,поэтому я хочу немного отличить его от этого.

OriginalGriff

Это не очень хороший вопрос - мы не можем понять из этого малого, что вы пытаетесь сделать.
Помните, что мы не можем видеть ваш экран, получить доступ к вашему жесткому диску или прочитать ваши мысли.
Используйте виджет "улучшить вопрос", чтобы отредактировать свой вопрос и предоставить более подробную информацию.

StackQ

смотрите мой вопрос по улучшению и предложите мне еще какой-нибудь формат для добавления комментария.

BotCar

Этот вопрос слишком открыт для раздела вопросов и ответов. Попробуйте начать дискуссию на одном из форумов, например Гостиная[^], Дизайн и архитектура[^], или даже язык Visual Basic[^].

StackQ

смотрите мой вопрос по улучшению и предложите мне еще какой-нибудь формат для добавления комментария.

1 Ответов

Рейтинг:
0

OriginalGriff

Это слишком открытый подход - нет стандарта для такого рода информации, либо у кодера будет свой собственный стиль, либо может быть стиль компании. Однако взгляните на это: http://www.icsharpcode.net/technotes/commenting20020413.pdf[^] - это вообще комментирование и охватывает историю модификаций.

Кстати: история изменений должна быть частью XML - комментариев, которые вы прикрепляете к своим методам, или, скорее, не в приведенном вами примере. Видеть здесь: http://msdn.microsoft.com/en-us/library/ms172652(v=против 80).aspx[^]. Это может иметь большое значение, чтобы использовать их, как Intellisense может забрать их, если ничего другого!