1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
<!doctype HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" >
<html>
<head>
<title>Tags supported by NDoc</title>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
<meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5">
<link rel="stylesheet" type="text/css" href="MSDN.css">
<style type="text/css">
.csharpcode
{
font-size: 8pt;
color: black;
font-family: Courier New , Courier, Monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0px; }
.rem { color: #008000; }
.kwrd { color: #0000ff; }
.str { color: #006080; }
.op { color: #0000c0; }
.preproc { color: #cc6633; }
.asp { background-color: #ffff00; }
.html { color: #800000; }
.attr { color: #ff0000; }
.alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0px;
}
.lnum { color: #606060; }
</style>
</head>
<body id="bodyID" class="dtBODY">
<div id="nsbanner">
<div id="bannerrow1">
<table class="bannerparthead" cellspacing="0" id="Table1">
<tr id="hdr">
<td class="runninghead">NDoc Documentation</td>
<td class="product"></td>
</tr>
</table>
</div>
<div id="TitleRow">
<h1 class="dtH1">Tags supported by NDoc</h1>
</div>
</div>
<div id="nstext">
<p>The MSDN documenter that ships with NDoc supports all the xml documentation tags
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfTagsForDocumentationComments.htm">defined</a>
in the C# Programmer's Reference.
It also supports new tags and extended syntax for
somestandard tags as described below.
</p>
<h4 class="dtH4">Section Tags</h4>
<p>Section tags are used to define the content of the different sections
of the documentation of a type or member.</p>
<p>These tags are used as top-level tags.</p>
<table class="dtTABLE" cellSpacing="0" style="WIDTH: 94%" ID="Table2">
<thead>
<tr vAlign="top">
<th width="33%">
Tag</th>
<th width="67%">
Description</th></tr>
</thead>
<tbody>
<tr vAlign="top">
<td><p><b><event></b></p></td>
<td><p>Use this tag to declare events that are raised by a member.
Syntax:
<pre class="csharpcode"><span class="rem">///<event cref="EventName">
/// Raised when something occurs.
///</event></span></pre>
</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><example></b></p></td>
<td><p>Example section. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfExample.htm">definition</a>.</p>
<p>If the example contains one or more <b><code></b> blocks, it must be
placed in an include file to avoid indentation problems.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><exception></b></p></td>
<td><p>Declares an exception that a member might throw. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfException.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><include></b></p></td>
<td><p>References an xml node in an include file that
contains one or more documentation section tags. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfInclude.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><overloads></b></p></td>
<td>
<p>This new tag allows providing documentation that applies
to all the overloads of a member. It only needs to be specified on the first overload.</p>
<p>The <b><overloads></b> tag can have two forms:</p>
<ul>
<li>In the short form, it includes only one or more text blocks that are
treated as the summary.</li>
<li>In the long form, it can include one or more applicable section tags
(summary, remarks and example).</li>
</ul>
<p>Example:</p>
<pre class="csharpcode"><!-- formatted by http://manoli.net/csharpformat/ -->
<span class="rem">///<overloads>This method has two overloads.</overloads></span>
<span class="rem">///<summary>This overload just says hello.</summary></span>
<span class="kwrd">public</span> <span class="kwrd">void</span> SayHello() { ... }
<span class="rem">///<summary>This one says hello to someone.</summary></span>
<span class="kwrd">public</span> <span class="kwrd">void</span> SayHello(<span class="kwrd">string</span> toSomeone) { ... }
</pre>
</td>
</tr>
<tr vAlign="top">
<td><p><b><param></b></p></td>
<td><p>Defines a member parameter. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfParam.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><permission></b></p></td>
<td><p>Define access permissions. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfPermission.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><remarks></b></p></td>
<td><p>Remarks section. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfRemarks.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><returns></b></p></td>
<td><p>Defines a member's return value. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfReturns.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><seealso></b></p></td>
<td><p>Adds a link to the See Also section. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfSeealso.htm">definition</a>.</p>
<p>Do <b>not</b> include this tag in the <b><remarks></b> section.</p>
<p>Alternate syntax:</p>
<ul>
<li><code class="rem"><seealso href="url">[label]</seealso></code></li>
<li><code class="rem"><seealso cref="member">[label]</seealso></code></li>
</ul>
</td>
</tr>
<tr vAlign="top">
<td><p><b><summary></b></p></td>
<td><p>The summary section. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfSummary.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><value></b></p></td>
<td><p>Defines a property value. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfValue.htm">definition</a>.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="dtH4">Block Tags</h4>
<p>Block tags are typically used inside <b><remarks></b>
and <b><example></b> sections to add structure to the text.</p>
<table class="dtTABLE" cellSpacing="0" style="WIDTH: 94%" ID="Table3">
<thead>
<tr vAlign="top">
<th width="33%">
Tag</th>
<th width="67%">
Description</th></tr>
</thead>
<tbody>
<tr vAlign="top">
<td><p><b><code></b></p></td>
<td><p>Code block. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfCode.htm">definition</a>.</p>
<p>Sections containing one or more <b><code></b> blocks must be placed
in an include file to avoid indentation problems.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><list></b></p></td>
<td><p>A definition list or table. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfList.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><para></b></p></td>
<td><p>Delimits a text paragraph. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfPara.htm">definition</a>.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="dtH4">Inline Tags</h4>
<p>Inline tags are typically used inside <b><para></b> blocks.</p>
<table class="dtTABLE" cellSpacing="0" style="WIDTH: 94%">
<thead>
<tr vAlign="top">
<th width="33%">
Tag</th>
<th width="67%">
Description</th></tr>
</thead>
<tbody>
<tr vAlign="top">
<td><p><b><c></b></p></td>
<td><p>Marks inline code. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfC.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><paramref></b></p></td>
<td><p>A reference to a parameter. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfParamref.htm">definition</a>.</p>
</td>
</tr>
<tr vAlign="top">
<td><p><b><see></b></p></td>
<td><p>Inline reference to another member or type. See Microsoft's
<a href="ms-help://MS.NETFrameworkSDKv1.1/csref/html/vclrfSee.htm">definition</a>.</p>
<p>Alternate syntax:</p>
<ul>
<li><code class="rem"><see href="url">[label]</see></code></li>
<li><code class="rem"><see cref="member">[label]</see></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
<p> </p>
</div>
</body>
</html>
|
