Добавление описаний класса для кодирования?
Я заканчиваю проект, я продолжал работать некоторое время, и просто ставлю последние штрихи.
Одна вещь, которую я хотел бы сделать, добавляют описания класса наверху каждого файла класса (для помощи мне, и другие программисты выясняют то, что продолжается). Моя мысль состоит в том, чтобы просто использовать набор '/''s к веревке от раздела для меня для написания некоторых записок, но возможно существует лучший путь? Существует ли созданный способом сделать это в Visual Studio?
/////////////////////////////////////////////////////
// //
// KillZombies.cs //
// //
// Description: This class contains blah blah blah //
// //
/////////////////////////////////////////////////////
3 ответа
Да, вы должны использовать нормальную XML документацию:
/// <summary>
/// Describe your class quickly here.
/// </summary>
/// <remarks>
/// Add more details here.
/// </remarks>
Так она будет отображаться в Intellisense, и если вы собираете документацию с помощью Sandcastle/ndoc/Doxygen и т.д., она будет отображаться соответствующим образом.
Если вы напечатаете "///" в строке над вашим классом, вы увидите подходящий шаблон для начала работы. Дополнительную информацию см. по ссылке MSDN выше.
Используйте комментарии к документации XML :
/// <summary>
/// This class performs an important function.
/// </summary>
Когда вы вводите три косой черты, Visual Studio поможет вам с остальным.
Не используйте причудливое форматирование ASCII, потому что при рефакторинге для изменения имен классов вы потратите целую вечность на переформатирование всех своих блоков, чтобы они снова выстроились в правильную линию.
Комментарии к документации XML, описанные в ответах выше, - это то, что нужно для документирования классов и методов.
Если вам требуется дополнительная информация в каждом файле для текста, не относящегося к документации, например, дата создания, кредиты, сообщения об авторских правах и так далее, вы можете добавить ее в виде сниппета или добавить ее в соответствующий шаблон Visual Studio. В VS есть специальные переменные для шаблонов, такие как $username$ и $time$, которые можно использовать для автоматической вставки этих значений каждый раз, когда вы добавляете новый элемент на основе вашего шаблона.