You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/csharp/language-reference/xmldoc/recommended-tags.md
+48-16Lines changed: 48 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,34 +126,66 @@ Some of the recommended tags can be used on any language element. Others have mo
126
126
:::row-end:::
127
127
-[Format documentation output](#format-documentation-output) - These tags provide formatting directions for tools that generate documentation.
128
128
:::row:::
129
-
:::column::: `<para>`:::column-end:::
130
-
:::column::: `<list>`:::column-end:::
131
-
:::column::: `<c>`:::column-end:::
132
-
:::column::: `<code>`:::column-end:::
133
-
:::column::: `<example>`\*\*:::column-end:::
129
+
:::column:::
130
+
`<para>`
131
+
:::column-end:::
132
+
:::column:::
133
+
`<list>`
134
+
:::column-end:::
135
+
:::column:::
136
+
`<c>`
137
+
:::column-end:::
138
+
:::column:::
139
+
`<code>`
140
+
:::column-end:::
141
+
:::column:::
142
+
`<example>`\*\*
143
+
:::column-end:::
134
144
:::row-end:::
135
145
-[Generate links and references](#generate-links-and-references) - These tags generate links to other documentation.
136
146
:::row:::
137
-
:::column::: `<see>`\*:::column-end:::
138
-
:::column::: `<seealso>`\*:::column-end:::
139
-
:::column::: `<cref>`:::column-end:::
140
-
:::column::: `<href>`:::column-end:::
147
+
:::column:::
148
+
`<see>`\*
149
+
:::column-end:::
150
+
:::column:::
151
+
`<seealso>`\*
152
+
:::column-end:::
153
+
:::column:::
154
+
`<cref>`
155
+
:::column-end:::
156
+
:::column:::
157
+
`<href>`
158
+
:::column-end:::
141
159
:::row-end:::
142
160
-[Tags used for methods](#document-methods) - These tags are used when documenting methods.
143
161
:::row:::
144
-
:::column::: `<returns>`:::column-end:::
145
-
:::column::: `<param>`\*:::column-end:::
146
-
:::column::: `<paramref>`:::column-end:::
147
-
:::column::: `<exception>`\*:::column-end:::
162
+
:::column:::
163
+
`<returns>`
164
+
:::column-end:::
165
+
:::column:::
166
+
`<param>`\*
167
+
:::column-end:::
168
+
:::column:::
169
+
`<paramref>`
170
+
:::column-end:::
171
+
:::column:::
172
+
`<exception>`\*
173
+
:::column-end:::
148
174
:::row-end:::
149
175
-[Tags used for properties](#document-properties) - This tag is used only on C# properties.
150
176
:::row:::
151
-
:::column::: `<value>`:::column-end:::
177
+
:::column:::
178
+
`<value>`
179
+
:::column-end:::
152
180
:::row-end:::
153
181
-[Tags for generic types and methods](#generic-types-and-methods) - These tags are used only on generic types and methods
154
182
:::row:::
155
-
:::column::: `<typeparam>`\*:::column-end:::
156
-
:::column::: `<typeparamref>`:::column-end:::
183
+
:::column:::
184
+
`<typeparam>`\*
185
+
:::column-end:::
186
+
:::column:::
187
+
`<typeparamref>`
188
+
:::column-end:::
157
189
:::row-end:::
158
190
159
191
The compiler verifies the syntax of the elements followed by a single \* in the preceding list. Visual Studio provides intellisense for the tags verified by the compiler and all tags followed by \*\* in the preceding list.
0 commit comments