19
¿Cómo se documentan las constantes de clase para phpDoc? He leído el manual pero no puedo encontrar nada sobre ellos.Documentación de las constantes de clase phpDoc
A
Respuesta
10
Estoy bastante seguro de que se puede utilizar @const, aunque no puedo encontrar ninguna documentación Inglés. Hay un ejemplo alemán here. Muestra define declaraciones en lugar de constantes de clase, pero IIRC la sintaxis es la misma.
+0
No lo sé por qué no está documentado pero parece funcionar, gracias ... – mck89
+6
Mejor revisión de la documentación '@ const' está aquí: http://stackoverflow.com/a/18446766/367456 - también explica que no existe tal cosa. – hakre
+3
En caso de usar '@ var' según esta respuesta: http://stackoverflow.com/a/27772200/2053165 – Leith
29
constantes solo necesitan un bloque de documentación que contiene la descripción. No es necesaria una etiqueta específica. El analizador de código identifica las constantes y las muestra como tales en la documentación generada (here's an example).
Cuestiones relacionadas
- 1. generador de documentación PHPDoc dentro o fuera de Eclipse?
- 2. ¿Dónde declarar las constantes de clase?
- 3. Constantes de clase
- 4. php/phpDoc - @return instancia de $ esta clase?
- 5. String.xml o constantes de clase
- 6. Constantes de clase en python
- 7. Las ventajas de las constantes
- 8. objetivo c constantes clase
- 9. Acceso PHP Clase Constantes
- 10. ¿Establecer constantes de clase después del constructor?
- 11. Constantes base de datos en una clase
- 12. Constantes de clase/estáticas en Delphi
- 13. Comentarios de PHPDoc en Notepad ++?
- 14. ¿Es posible redefinir las constantes de PHP?
- 15. OR bit a bit de las constantes
- 16. PHPdoc: ¿Documentando métodos encadenables?
- 17. constantes de cadena estática en clase vs espacio de nombres para constantes [C++]
- 18. ¿Dónde declarar/definir constantes de alcance de clase en C++?
- 19. Tener una clase "constantes" en JSF
- 20. ¿Las constantes globales son un antipatrón?
- 21. ¿Cómo usar phpDoc con métodos sobrecargados?
- 22. PHPDoc en línea {@link} (y Netbeans)
- 23. Scala: compila las constantes de tiempo
- 24. Representación de las constantes binarias C#
- 25. ¿Cómo cambiar las constantes de PHP?
- 26. mejores prácticas de C++ para las constantes
- 27. C# - ¿son todas las constantes de Enum?
- 28. Cómo definir adecuadamente las constantes
- 29. Uso de las constantes de cadena en la conversión implícita
- 30. ¿Cómo escapar de un comentario de phpdoc en el comentario de phpdoc?
usando '@ var' es la forma correcta de hacerlo, consulte https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#722-var – m13r