Every function, including object methods, must have a docblock that contains at a minimum
Every class must have a docblock that contains these phpDocumentor tags at a minimum
Cada clase debe contener un bloque de documentación que contenga como mínimo las siguientes etiquetas phpDocumentor
There is a file header DocBlock which is used to give an overview of what is contained in the file.
Hay un archivo llamado DocBlock, el cual es utilizado para dar una perspectiva que está contenida en el archivo.
Tags are only processed if they are the first thing in a DocBlock line, for example
Las etiquetas solo son procesadas si son el primer elemento en una línea DocBlock, por ejemplo
DocBlock tags allow developers to define authors of a file, the license for a class, the property or method information, and other useful information.
Las etiquetas de DocBlock permiten a los desarrolladores a definir autores para el archivo, la licencia para la clase, la información de la propiedad o el método, y otra información útil.
While not an official part of OOP, the DocBlock commenting style is a widely accepted method of documenting classes.
Aunque no es una parte oficial de la POO, el estilo de comentarios DockBlock es un método ampliamente aceptado de documentar clases.
author: The author of the current element (which might be a class, file, method, or any bit of code) are listed using this tag. Multiple author tags can be used in the same DocBlock if more than one author is credited.
author: El autor del elemento actual (como podría ser una clase, archivo, método, o cualquier pedazo de código) se lista usando esta etiqueta Se pueden usar múltiples etiquetas de autor en el mismo DocBlock si hay más de un autor involucrado.
The file starts like a regular PHP file with a DocBlock and then the code for an ABSPATH check so that no one can access the file directly.
El archivo comienza como un archivo normal PHP con un DocBlock y después el código para una verificación ABSPATH, para que nadie pueda tener acceso al archivo de forma directa.
If a docblock is not located where it is expected, the compiler will throw an exception.
Si un bloque de comentarios no esta ubicado donde sea esperado, el compilador lanzará una excepción.
The file may contain classes or arbitrary PHP code, as well as a file-level docblock if desired.
El archivo puede contener clases o código PHP arbitrario, así como un archivo de nivel docblock si así lo desea.
All class files must contain a "file-level" docblock at the top of each file and a "class-level" docblock immediately above each class.
Todos los archivos de clase deben contener un bloque de documentación "a nivel de archivo" al principio de cada archivo y un bloque de documentación "a nivel de clase" inmediatamente antes de cada clase.
Once you scan the preceding class, the benefits of DocBlock are apparent: everything is clearly defined so that the next developer can pick up the code and never have to wonder what a snippet of code does or what it should contain.
Un ejemplo de todo está claramente definido de tal forma que el siguiente desarrollador que trate el código nunca tendrá que suponer qué hace un fragmento de código o qué debería contener.
Every file that contains PHP code must have a docblock at the top of the file that contains these phpDocumentor tags at a minimum
Cada archivo que contenga código PHP debe tener un bloque de documentación al principio del archivo que contenga como mínimo las siguientes etiquetas phpDocumentor