Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rephrase the multi-line comments rule to be more precise regarding localization (translations) #42672

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
BillWagner marked this conversation as resolved.
Show resolved Hide resolved
- 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
Loading