Peli's Farm - NDoc 1.3 new feature: Custom Tags

Friday, April 16, 2004

NDoc, the best and free documentation compiler for C# has lately released v1.3. This version adds a very interresting new feature: custom tags.Basically, you just need to provide the XSLT templates to NDoc and it use them to render you tags: simple, efficient and highly customizable.

In the NCollection project, we needed a way to easily document the complexity of methods (average and worst). A custom tag was the perfect solution for that: (hint: I'm using brackts intead of minus/greater)

/// [complexity worst="n" average="1" /]
public void Method()
{...}

Starting from the NDoc example, the XSLT stylesheet to render this tag is:

[xsl:template mode="remarks-section" match="complexity">
[H4 class=dtH4>Complexity[/H4]
    [UL]
        [LI]Average: O([xsl:value-of select="@average"][/xsl:value-of])
        [LI]Worst-case: O([xsl:value-of select="@worst"])[/LI]
    [/UL]
    [xsl:apply-templates select="*"/]
[/xsl:template]

Et voilà!

posted on Saturday, April 17, 2004 2:34:00 AM UTC

Comments [1]
Tracked by:
"diovan" (online) [Trackback]

Monday, June 06, 2005 6:15:37 PM UTC

Hi,
 I maked my own history class tag that handle version, programer and date for each event.
 
 In code :
 ///<history>
 ///<log programer="Programer's name"
 date="11 février 2005"
 version="1.0">
 ///<event>bug #666 resolved...</event>
 ///<event>minor user interface modifcations...</event>
 ///</log>
 /// ...
 ///</history>
 
 XSLT file template :
 <xsl:template match="history"
 mode="seealso-section">
 <H4 class="dtH4">History</H4>
 
 <ul type="disc">
 
 <xsl:for-each select="log">
 <li>
 v<xsl:value-of select="@version"/> -
 <xsl:value-of select="@programer"/>
 (<xsl:value-of select="@date"/>)
 
 
 <ul>
 
 <xsl:for-each select="event">
 <li>
 <xsl:value-of select="."/>
 </li> </xsl:for-each>
 </ul>
 </li>
 </xsl:for-each>
 </ul>
 </xsl:template>
 
 Met ça dans ta pipe pis fume toi ! ;)

le_mulot

Comments are closed.

Disclaimer
The opinions expressed herein are my own personal opinions and do not represent my employer's view in anyway.