Документация C# - Определенные пользователем теги

Question

Я хочу документировать исходный источник (источники C#), и я использую теги документации XML. Как я могу определить по определенным тегам?

Например, я использую много предложений Design by Contract. Я хотел бы иметь разделы документации предусловий, Постусловие, инварианты ... Это должно быть desiderable писать документацию, как:

/// <precond>arg != null</precond> 
/// <postcond>return > 0</postcond> 

Поскольку я не XML-гуру, кто-то из вас (гуру) Можете мне посоветовать?

Я попытался использовать < include>, но это невозможно (для меня), чтобы документация была построена правильно.

Большое спасибо

Answer 1

Использование NDoc для составления документации и ее custom tags может быть решением. Одной из проблем с NDoc является то, что разработка была остановлена ​​некоторое время назад.

Sandcastle also supports custom tags, я не уверен, что это работает Sandcastle Builder, хотя если это проблема.

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

<xsl:template match="myTag" mode="seealso-section"> 
    <h1 class="green"> 
     <xsl:value-of select="." mode="slashdoc"/> 
    </h1> 
    </xsl:template>  
    <xsl:template match="null" mode="slashdoc"> 
    <xsl:text> null reference (Nothing in Visual Basic) </xsl:text> 
</xsl:template> 

XML-(csc.exe /doc), который построен компилятор не имеет пространства имен насильственных в тегах, так что вы можете использовать любые тег, вам нравится.

Answer 2

Сначала very usefull description, что возможно с комментариями XML.

Следующее, что приложения, создающие вашу документацию, должны быть осведомлены о ваших собственных тегах. В настоящее время я не знаю конструктора документации, который может быть дополнен дополнительными атрибутами или элементами.