Esiste uno standard di codifica PHPCS che consente di verificare che le annotazioni appropriate (@param
, @return
, @throws
, ecc.) Siano presenti in un docblock, inclusa la spaziatura corretta tra di esse?Esiste uno standard PHPCS per il targeting di docblock PHP?
risposta
Provare a eseguire il seguente comando e vedere se produce ciò che si vuole:
phpcs /path/to/code --standard=Squiz --sniffs=Squiz.Commenting.FunctionComment,Squiz.Commenting.FunctionCommentThrowTag,Squiz.Commenting.ClassComment,Squiz.Commenting.FileComment,Squiz.Commenting.VariableComment
Se è così, è possibile creare il proprio standard che comprende solo quelli annusa, e quant'altro si desidera controllare . A tale scopo, crea un file ruleset.xml
e utilizzalo come standard.
Ad esempio, è possibile creare un file chiamato mystandard.xml
e includere il seguente contenuto:
<?xml version="1.0"?>
<ruleset name="MyStandard">
<description>My custom coding standard.</description>
<rule ref="Squiz.Commenting.FunctionComment" />
<rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
<rule ref="Squiz.Commenting.ClassComment" />
<rule ref="Squiz.Commenting.FileComment" />
<rule ref="Squiz.Commenting.VariableComment" />
</ruleset>
Quindi è possibile eseguire questo comando:
phpcs /path/to/code --standard=/path/to/mystandard.xml
Ci sono altre cose che si possono fare in un file ruleset.xml
. Vedere la documentazione qui: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
Nel 2017 si dispone ora di più per mangiare:
- uno dei migliore annusa per controllare docblocks è TypeHintDeclarationSniff from SlevomatCodingStandard, funziona alla grande con PHP 7, PHP 7.1, rilasciare documenti inutilizzati, ecc .
- inoltre è possibile fare uso di un altro strumento - PHP-CS-Fixer, lì si può trovare più fissatori, che vi aiuterà con docblock, basta cercare "doc"
- 1. Esiste uno stile standard per la documentazione in PHP?
- 2. Esiste un framework standard per php?
- 3. Sono disponibili strumenti di parser PHP DocBlock?
- 4. PHPStorm Errore di lancio durante il tentativo di eseguire phpcs
- 5. PhpStorm sta gettando un errore per phpcs
- 6. Esiste uno standard per il calcolo della funzione di aggregazione SQL?
- 7. Posso sovrascrivere il set di regole phpcs usato per file se sì, come?
- 8. Esiste uno strumento per l'applicazione degli standard di codifica per Scala?
- 9. Esiste uno standard che regola i cookie __utma, __utmz, ecc.?
- 10. Esiste un DocBlock PHP che posso usare per denotare una proprietà del metodo magico aggiunta dopo l'istanziazione?
- 11. Esiste uno standard per l'utilizzo di PBKDF2 come hash della password?
- 12. È u_char uno standard?
- 13. Esiste uno standard in java per _ (trattino basso) davanti a nomi di variabili o classi?
- 14. È sicuro utilizzare le specifiche tecniche C++ approvate per uno standard futuro in uno standard precedente?
- 15. Esiste una funzione standard di Delphi per l'escape dell'HTML?
- 16. Esiste un componente standard per il pannello comprimibile in Qt?
- 17. Esiste uno schema di progettazione per questo?
- 18. Come aggiornare e generare DocBlock per l'intero progetto in PhpStorm?
- 19. Implementazione di uno standard di denominazione per chiavi, indici, vincoli
- 20. Esiste uno schema XML per il contesto.xml di Tomcat 6?
- 21. Perché non esiste uno standard codec video HTML5 comune per tutti i browser?
- 22. Esiste uno standard per memorizzare nome utente e password nelle applicazioni WP7?
- 23. Esiste uno static_warning?
- 24. Qualcuno cambia lo stile di controvento predefinito di Visual Studio? - Esiste uno standard?
- 25. Mobile App - Targeting per iPhone, WP7, Android e Blackberry
- 26. Esiste un modello di progettazione standard per ExtJS
- 27. Esiste una versione standard, striata di memcpy?
- 28. Esiste un functor di eliminazione standard?
- 29. Esiste una classe standard per rappresentare un "intervallo" in .net?
- 30. Esiste un omniauth per php?
Questa risposta è del 2012. È ancora corretta. Ma vorrei aggiungere che oggi puoi anche usare l'annusamento Generic.Commenting.DocComment. Questi sniff si comportano in modo leggermente diverso, quindi scegli quello che è meglio per il tuo stile. – mkasberg