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.

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

rule for testing phpdoc #8

Closed
StephanKrauss opened this issue Aug 8, 2018 · 1 comment
Closed

rule for testing phpdoc #8

StephanKrauss opened this issue Aug 8, 2018 · 1 comment

Comments

@StephanKrauss
Copy link

Hi Michael,

I'm looking for a role for phpmd.
This role should identify if a script has been sufficiently documented.
I think that the number of lines of a file in the relation of the comment lines must be evaluated. Can you help with an idea?

Greeting Stephan

@mi-schi
Copy link
Owner

mi-schi commented Aug 9, 2018

The only rule for commentsbin this repo is this on: https://github.com/mi-schi/phpmd-extension/blob/master/rulesets/naming.xml#L47-L50
Unseless comments

The structure of comments are defined in PHPCS:

https://github.com/squizlabs/PHP_CodeSniffer/tree/master/src/Standards/Squiz/Sniffs/Commenting

@mi-schi mi-schi closed this as completed Aug 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants