Есть ли стандарт (например, phpdoc или строка документации python) для комментирования кода C #?

StackOverflow https://stackoverflow.com/questions/34516

  •  09-06-2019
  •  | 
  •  

Вопрос

Существует ли стандартное соглашение (например, phpdoc или строка документации python) для комментирования кода C #, чтобы документация класса могла автоматически генерироваться из исходного кода?

Это было полезно?

Решение

Вы можете использовать комментарии в стиле XML и использовать инструменты для извлечения этих комментариев в документацию API.

Вот пример стиля комментария: 

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)

Вот некоторые вещи, которые могут помочь в этом:

GhostDoc , которые предоставляют единую комбинацию клавиш для автоматического создания комментариев для класса или метода , Sandcastle , который генерирует документацию в стиле MSDN из комментариев XML.

Другие советы

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>

http://msdn.microsoft.com/en-us/magazine /cc302121.aspx

Microsoft использует " комментарии к документации XML " который предоставит описания intellisense IDE, а также позволит вам автоматически генерировать документацию в стиле MSDN, используя такой инструмент, как Sandcastle, если вы включите генерацию вывода XML-файла.

Чтобы включить генерацию XML-файла для документации, щелкните правой кнопкой мыши проект в Visual Studio, выберите " Свойства " и перейдите в раздел "Build" Вкладка. Внизу вы можете указать место для вашего файла вывода XML-комментариев.

Предыдущие ответы прекрасно указывают на синтаксис XML. Я просто хотел добавить свою рекомендацию для бесплатного (и с открытым исходным кодом) генератора справочной библиотеки nDoc , который анализирует все комментарии в проекте.

C # имеет встроенные команды документации Веселись!

Мне всегда говорили использовать блочные комментарии, открытые двумя или более звездочками, которые разделяют комментарии документации. 

/**
Documentation goes here.
(flowerboxes optional) 
*/
Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top