Skip to content

Commit 1b32396

Browse files
authoredApr 29, 2019
quote various comment tags that weren't rendered
parts of the Comment section weren't being rendered properly as the xml tags that were being described were not quoted.
1 parent 947712a commit 1b32396

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed
 

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,9 @@ Example:
240240
```
241241
28. Always apply C# comment-blocks (///) to public, protected, and internal declarations.
242242
29. Only use C# comment-blocks for documenting the API.
243-
30. Always include <summary> comments. Include <param>, <return>, and <exception> comment
243+
30. Always include <summary> comments. Include `<param>`, `<return>`, and `<exception>` comment
244244
sections where applicable.
245-
31. Include <see cref=””/> and <seeAlso cref=””/> where possible.
245+
31. Include `<see cref=""/>` and `<seeAlso cref=""/>` where possible.
246246
32. Always add CDATA tags to comments containing code and other embedded markup in order to avoid
247247
encoding issues.
248248
Example:
@@ -252,7 +252,7 @@ Example:
252252
/// <code><![CDATA[
253253
/// <configuration>
254254
/// <appSettings>
255-
/// <add key=mySetting value=myValue/>
255+
/// <add key="mySetting" value="myValue"/>
256256
/// </appSettings>
257257
/// </configuration>
258258
/// ]]></code> >

0 commit comments

Comments
 (0)
Please sign in to comment.