Current CGL states that every method has to have a docComment / phpDoc - even methods without parameters or return types - for example constructors, resulting in comments like “constructor”. I’d like to propose to make the description part of the docComment (and thus the whole comment if no params/return type) optional to also get rid of simple getter/setter comments (what’s the benefit of the “get the ID” comment on top of a getId() method?).
- CGL Adjustment to allow methods without comment
- Less “noise”
- Higher percentage of comments you should actually read
- Less strict rules, developers need to think about comment necessity (and content) more
Remarks and notes
Topic Initiator: Susi Moog
Topic Mentor: Susi Moog