Skip to content

Commit

Permalink
Rephrase the multi-line comments rule to be more precise
Browse files Browse the repository at this point in the history
  • Loading branch information
BartoszKlonowski committed Sep 20, 2024
1 parent 7fcee6c commit 8c5523b
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ In general, use the following format for code samples:
### Comment style

- Use single-line comments (`//`) for brief explanations.
- Avoid multi-line comments (`/* */`) for longer explanations. Comments aren't localized. Instead, longer explanations are in the companion article.
- Avoid multi-line comments (`/* */`) for longer explanations.<br/>Comments in the code samples aren't localized. Which means explanations embedded in the code will not be translated. So longer, explanatory text should be placed in the companion article, so that it can be localized.
- For describing methods, classes, fields, and all public members use [XML comments](../../language-reference/xmldoc/index.md).
- Place the comment on a separate line, not at the end of a line of code.
- Begin comment text with an uppercase letter.
Expand Down

0 comments on commit 8c5523b

Please sign in to comment.