Motivation
The issues I found with comments are due to practical reasons. In particular:
- There should be no empty lines between the comments and the referred item
- This will avoid ambiguities.
- I guess I mostly fixed that with this PR.
- There's no standard item's comment structure
- I would love to define a simple Rule Doc convention (i.e., something similar to Go Doc Comments, but simpler)
- There's no clear way to distinguish sections from item's comment
Feature
Implement a simple Rules Doc Comments guideline and add it to the rules style guide.
Alternatives
Just rely on an existing convention, if any, or do nothing. However they don't look like compelling alternatives.
Additional context
See #149 (comment)
Motivation
The issues I found with comments are due to practical reasons. In particular:
Feature
Implement a simple Rules Doc Comments guideline and add it to the rules style guide.
Alternatives
Just rely on an existing convention, if any, or do nothing. However they don't look like compelling alternatives.
Additional context
See #149 (comment)