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.

Sign up for GitHub

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

Jump to bottom

Format Comments in Common props, targets and tasks #6160

Closed
wants to merge 4 commits into from
Closed

Format Comments in Common props, targets and tasks #6160

wants to merge 4 commits into from

Commits on Nov 5, 2021

  1. Update EditorConfig 

    Add charset, defaulting to UTF-8
Categorically separate source files
Don't insert new-line at end of file
    @Nirmal4G
    Nirmal4G committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    867a3df View commit details
    Browse the repository at this point in the history

  2. Clean-up MSBuild XML files 

    Remove trailing whitespace
Adjust New Lines where necessary
Follow uniform Indentation format
    @Nirmal4G
    Nirmal4G committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    a7717af View commit details
    Browse the repository at this point in the history

  3. Add/Update MSBuild XML file headers 

    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.
    @Nirmal4G
    Nirmal4G committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    61de9e4 View commit details
    Browse the repository at this point in the history

  4. Format Comments in Common props/targets/tasks 

    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
    @Nirmal4G
    Nirmal4G committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    67ffa50 View commit details
    Browse the repository at this point in the history