Расширение VSCode для написания документации на c#
Подскажите расширение VSCode для работы с комментариями, оформленные специальным образом (xml комментарии), которые необходимы чтобы создавать xml файл, которые можно потом использовать для создания документации.
Вот с такими вещами, для примера
/// <summary>
/// что-то здесь
/// </summary>
Ответы (1 шт):
Автор решения: Dmitry
→ Ссылка
Нашел то, что искал C# XML Documentation Comments.
После активации расширения тройной слэш сразу добавляет строки документации в зависимости от сущности перед, которой это используется.
Здесь приведу настройку settings.json, которая наглядно показывает какие теги автоматически используются при той или иной конструкции
"docomment.advanced": {
"cs": {
"namespace" : {
"attributes" : ["summary"]
},
"class" : {
"attributes" : ["summary", "typeparam"]
},
"interface" : {
"attributes" : ["summary", "typeparam"]
},
"struct" : {
"attributes" : ["summary"]
},
"enum" : {
"attributes" : ["summary"]
},
"delegate" : {
"attributes" : ["summary", "param", "typeparam", "returns"]
},
"field" : {
"attributes" : ["summary"]
},
"property" : {
"attributes" : ["summary", "value"]
},
"method" : {
"attributes" : ["summary", "param", "typeparam", "returns"]
},
"event" : {
"attributes" : ["summary"]
}
}