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: documentation/SA1642.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
## SA1642
1
+
## SA1642
2
2
3
3
<table>
4
4
<tr>
@@ -41,6 +41,17 @@ public Customer()
41
41
}
42
42
```
43
43
44
+
If documenting a struct, the summary must contain the word 'struct' instead of 'class'. For example, the following shows the constructor for the `MyStruct` struct.
45
+
46
+
```csharp
47
+
/// <summary>
48
+
/// Initializes a new instance of the <seecref="MyStruct"/> struct.
49
+
/// </summary>
50
+
publicMyStruct()
51
+
{
52
+
}
53
+
```
54
+
44
55
If the class contains generic parameters, these can be annotated within the `cref` link using either of the following
0 commit comments