По какому соглашению разработчики C# указывают свое авторство класса?
Я прочитал из нескольких мест и узнал, что в комментариях C# XML нет автора. Но я уверен, что часто встречаются ситуации, когда мы должны использовать некоторые способы, чтобы сказать людям, что тот или иной класс написан кем и кем.
Для себя я работаю над проектом с несколькими людьми, и иногда полезно знать, кто написал класс, дату его последнего изменения и т. Д.
В Java есть @author, @modifiedи т. д. params для комментариев, которые будут генерироваться в документе. Я новичок в C#. Поскольку в комментарии XML нет тега автора, что за соглашение используют разработчики на C#, когда хотят указать, что определенный класс был ими написан?
3 ответа
Немногие профессиональные программисты на C# работают без контроля исходного кода, и тег "author" или "ified "совершенно бессмыслен, если вы используете контроль исходного кода; следовательно, нет никаких соглашений по этому вопросу.
VB в одном из тех редких случаев, когда лучше создать файл с именем VBAxmldoc.xml, чтобы вы могли на самом деле настроить шаблоны для каждого ключевого слова. C# не имеет такой возможности, вы можете, если у вас есть реальное желание сделать это, и у вас нет такого человека, как я, чтобы обойти это, создать фрагмент кода с комментариями к нему, например, Author. скажем, создать класс, а затем использовать его.
Я бы предложил использовать XML <remarks>, Или вы можете сделать то, что делает большинство разработчиков и создать /* ... */ блок в верхней части файла.