Skip to content
This repository has been archived by the owner on May 28, 2022. It is now read-only.

Add XML coding standards #84

Open
PierceAndy opened this issue Mar 29, 2017 · 2 comments
Open

Add XML coding standards #84

PierceAndy opened this issue Mar 29, 2017 · 2 comments

Comments

@PierceAndy
Copy link

PierceAndy commented Mar 29, 2017

Reason: Markup languages tend to have deep nesting.

  • Space before self-closing tag (i.e. />)

Reason: Readability.

  • Line wrap at so & so number of characters (to be defined).
  • Header comments for code block, should be inside or outside?
@PierceAndy
Copy link
Author

PierceAndy commented Mar 29, 2017

Possibly add a sub-section specifically for checkstyle.xml files.

  • Properties with default values that aren't changed shouldn't be included (e.g. severity property has default value of error. If using the default value, don't include it. Discussion here and here)
  • If using the same module multiple times, don't omit properties with default values if these properties are different across modules with the same name (Discussion here)
  • One value per property (e.g. from official checkstyle configuration)

@yamgent
Copy link
Contributor

yamgent commented Mar 29, 2017

Possibly add a sub-section specifically for checkstyle.xml files.

That problem does appear outside checkstyle.xml actually. (e.g. JavaFx's FXML files).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants