Там публикуются инструкции по стилю для документации XML C#? [закрытый]

]Если вам нужно общее руководство по использованию XML документации, ниже приведены две очень полезные ссылки (на которые я ссылался много раз).[

] [
• ][]MSDN Recommended Tags for Documentation Comments[][
] [
• ][]C# XML Documentation : Alan Dean[] (мертвый - []архивная версия[]) [
] [

]Я полагаю, что это смутно, что вы ищете. Что касается фактической формулировки и грамматики XML комментариев, я тоже искал советы/руководства по этому поводу, но безрезультатно. Лучшая идея в этом отношении - просто следовать .NET BCL (Base Class Library) - хотя есть странное несоответствие даже в документации BCL.[

]Надеюсь, это поможет...[

]Моя надстройка для визуальной студии, []AtomineerUtils[], будет генерировать и обновлять XmlDoc комментарии.[

]Она имеет набор шаблонов, которые позволяют точно указать стиль (какие записи допустимы для различных типов элементов кода, в каком порядке они перечислены, есть ли пустые строки между определенными элементами, и стиль блока сопроводительной документации). Он удалит записи, которые более не являются корректными (например, удалит параметры), и добавит записи для недокументированных функций (например, новые параметры или брошенные исключения), а также сохранит документацию аккуратной, используя автоматический отступ и обертку слов.[

]Таким образом, используя AU для генерации и обновления ваших комментариев, вы можете очень легко применить определенный стиль и компоновку для ваших комментариев к документации. Если вы хотите использовать StyleCop для внедрения некоторых правил документирования, AtomineerUtils имеет возможность создавать документацию в формате, совместимом с StyleCop.[

]Это также делает документирование кода настолько быстрым и простым, что даже менее желающие программисты в вашей команде будут гораздо более склонны хорошо документировать свой код.[