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: StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1642ConstructorSummaryDocumentationMustBeginWithStandardText.cs
-44Lines changed: 0 additions & 44 deletions
Original file line number
Diff line number
Diff line change
@@ -112,50 +112,6 @@ internal class SA1642ConstructorSummaryDocumentationMustBeginWithStandardText :
/// Gets the standard text which is expected to appear at the beginning of the <c><summary></c>
117
-
/// documentation for a non-private constructor.
118
-
/// </summary>
119
-
/// <value>
120
-
/// The standard text which is expected to appear at the beginning of the <c><summary></c> documentation
121
-
/// for a non-private constructor. This text appears before the name of the containing class, followed by a
122
-
/// <c><see></c> element targeting the containing type, and finally followed by <c>class</c> or
123
-
/// <c>struct</c> as appropriate for the containing type.
124
-
/// </value>
125
-
publicstaticstringNonPrivateConstructorStandardText{get;}="Initializes a new instance of the ";
126
-
127
-
/// <summary>
128
-
/// Gets the standard text which is expected to appear at the beginning of the <c><summary></c>
129
-
/// documentation for a private constructor.
130
-
/// </summary>
131
-
/// <remarks>
132
-
/// <para>In addition to the format given in <see cref="PrivateConstructorStandardText"/>, a private constructor
133
-
/// may choose to use <see cref="NonPrivateConstructorStandardText"/> instead. The code fix provided for this
134
-
/// diagnostic uses <see cref="NonPrivateConstructorStandardText"/> by default, since this is generally a more
135
-
/// accurate representation of a user's intent. In new code, <see langword="static"/> classes provide a
136
-
/// superior alternative to private constructors for the purpose of declaring utility types that cannot be
137
-
/// instantiated.</para>
138
-
/// </remarks>
139
-
/// <value>
140
-
/// The standard text which is expected to appear at the beginning of the <c><summary></c> documentation
141
-
/// for a private constructor. The first element appears before the name of the containing class, followed by a
142
-
/// <c><see></c> element targeting the containing type, then by <c>class</c> or <c>struct</c> as
143
-
/// appropriate for the containing type, and finally followed by the second element of this array.
144
-
/// </value>
145
-
publicstaticImmutableArray<string>PrivateConstructorStandardText{get;}=ImmutableArray.Create("Prevents a default instance of the "," from being created");
146
-
147
-
/// <summary>
148
-
/// Gets the standard text which is expected to appear at the beginning of the <c><summary></c>
149
-
/// documentation for a static constructor.
150
-
/// </summary>
151
-
/// <value>
152
-
/// The standard text which is expected to appear at the beginning of the <c><summary></c> documentation
153
-
/// for a static constructor. The first element appears before the name of the containing class, followed by a
154
-
/// <c><see></c> element targeting the containing type, and finally followed by <c>class</c> or
155
-
/// <c>struct</c> as appropriate for the containing type.
156
-
/// </value>
157
-
publicstaticstringStaticConstructorStandardText{get;}="Initializes static members of the ";
0 commit comments