Format Comments in Common props, targets and tasks #6160
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add charset, defaulting to UTF-8 Categorically separate source files Don't insert new-line at end of file
Remove trailing whitespace Adjust New Lines where necessary Follow uniform Indentation format
For shipping XML/XAML files, add missing file header comment based on the comment text equivalent to what is specified in the other XML/XAML files. Also, Try to provide a short description of the file's form and function.
Follow 2-space indent everywhere
For Multi-line comments, text starting between
comment tags should be 4-space and extra 2-space
for the text that follows from the previous line.
Example:
```xml
<!-- Single Line Comment Text -->
<!--
Multi Line Comment Text
Another Comment Text
Indented Comment Text
-->
```
Ensure they follow consistent formatting
|
Closing this since I re-forked the repo, the branch ref to this PR was removed as well. I'll open a new PR soon. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #TBA
Context
Make Common props, targets and tasks easier to read and understand.
The Comments in Common props, targets and tasks doesn't have a clear format.
Also, some comments got messed up really bad that they appear next line to source instead of before.
Thus, I propose a simple comment style and format comments according to that.
Part of the larger refactoring that'll lead into #1686
Changes Made
Fixup the Comments across Common props, targets and tasks files
Ensure they follow consistent formatting
E.g.: 2-space indent
Testing
NIL
Notes
I'll update the style patterns one by one as I do the formatting.
I'll also separate the commits by comment style or by code block and/or by file to make reviewing easier.
For now, I'm placing this in Draft since there are many comments to be formatted.
Please hold up your reviews until it's out of draft.