sonar-openedge icon indicating copy to clipboard operation
sonar-openedge copied to clipboard

Rule idea: Check for presence of documentation comments

Open cverbiest opened this issue 6 years ago • 0 comments

Each class, public/protected property and method should have a documentation header. This rule would flag all classes, properties and methods that don't have such a header.

I think it would need some configuration options

  • is documentation required on public/protected/private . If you set it to private documtation will be required on all
  • required on the class
  • required for properties
  • required for methods
  • which comment style, ABLDoc, Javadoc style (see ABLDuck https://github.com/Riverside-Software/pct/wiki/ABLDuck) or either will do

cverbiest avatar Jan 22 '19 09:01 cverbiest