Add developer documentation for PHPDoc #157
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Création des standards de documentation PHP pour le Core Jeedom, basés sur les discussions https://community.jeedom.com/t/aide-phpdoc-du-core/63287 . Ces standards définissent les règles pour une documentation PHPDoc claire, concise et utile.
Les règles couvrent :
Ajout d'une section dédiée à la documentation PHP :
Je n'ai pas fait les traductions dans les autres langues. Je peux le faire au besoin.
Suggested changelog entry
Ajout des standards de documentation PHP et d'une section dédiée dans la documentation développeur.
Related issues/external references
jeedom/core#3011
Types of changes
PR checklist