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

Analyse and implement some extra checks about phpdoc blocks spacing and tags groups #136

Open
stronk7 opened this issue Mar 27, 2024 · 0 comments

Comments

@stronk7
Copy link
Member

stronk7 commented Mar 27, 2024

This comes from #134, where it was detected that a few (minor) style details are not being checked currently. Here it's an initial list, to be discussed, analysed...

  • Blank line between summary (short desc) and description (and for which artifacts).
  • Blank like between descriptions and tags.
  • Maybe some ordering and spacing between tag "groups" (copyright, author, license => params => return => other tags)
  • ....

(As reference, when not specified by our own coding style, we should follow the PSR-5: PHPDoc draft.

Ciao :-)

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

1 participant