Herramientas de usuario
ingenieria:estandard-de-codificacion
Diferencias
Muestra las diferencias entre dos versiones de la página.
| Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
|
ingenieria:estandard-de-codificacion [2014/05/26 20:01] [Alineamientos] |
ingenieria:estandard-de-codificacion [2016/01/05 23:15] (actual) |
||
|---|---|---|---|
| Línea 17: | Línea 17: | ||
| Las definiciones de clases, propiedades de clase, métodos y funciones deben tener su correspondiente DocBlock de PHPDoc. Los algoritmos complejos deben documentarse con comentarios de una sola línea o de múltiples líneas si se da una explicación general. | Las definiciones de clases, propiedades de clase, métodos y funciones deben tener su correspondiente DocBlock de PHPDoc. Los algoritmos complejos deben documentarse con comentarios de una sola línea o de múltiples líneas si se da una explicación general. | ||
| - | <code>/** | + | <code> |
| + | /** | ||
| * @param string $prop_slug El slug del campo buscado | * @param string $prop_slug El slug del campo buscado | ||
| * @param mixed $prop_value El nuevo valor del campo | * @param mixed $prop_value El nuevo valor del campo | ||
| Línea 84: | Línea 85: | ||
| * Entre una estructura de control o definición de método o función y la llave de apertura del bloque que define. [líneas 3 y 4] | * Entre una estructura de control o definición de método o función y la llave de apertura del bloque que define. [líneas 3 y 4] | ||
| * Entre los parámetros de la definición o llamada a una función o método. [líneas 3, 5 y 16] | * Entre los parámetros de la definición o llamada a una función o método. [líneas 3, 5 y 16] | ||
| - | * Entre los caracteres de slash "//" y los comentarios de una línea. [líneas 5, 6 y 8] ==== No se deja un espacio en blanco: ==== * Entre un operador unario y su operando. [línea 4] * Entre los operandos del operador flecha "→". [línea 16] * Entre el nombre de un método o función y los paréntesis de definición de parámetros. [línea 3] * La llamada a un constructor, método, o función y la lista de parámetros. [líneas 15 y 16] * Una variable de tipo array y los corchetes que especifican el índice a acceder. [línea 8] ==== Se deja una línea en blanco: ==== * Después del cierre de un bloque de código. [líneas 7, 10 y 14] * Entre agrupaciones de sentencias altamente cohesivas. [línea 7] | + | * Entre los caracteres de slash "//" y los comentarios de una línea. [líneas 5, 6 y 8] |
| + | |||
| + | ==== No se deja un espacio en blanco: ==== | ||
| + | |||
| + | * Entre un operador unario y su operando. [línea 4] | ||
| + | * Entre los operandos del operador flecha "->". [línea 16] | ||
| + | * Entre el nombre de un método o función y los paréntesis de definición de parámetros. [línea 3] | ||
| + | * La llamada a un constructor, método, o función y la lista de parámetros. [líneas 15 y 16] | ||
| + | * Una variable de tipo array y los corchetes que especifican el índice a acceder. [línea 8] | ||
| + | |||
| + | ==== Se deja una línea en blanco: ==== | ||
| + | |||
| + | * Después del cierre de un bloque de código. [líneas 7, 10 y 14] | ||
| + | * Entre agrupaciones de sentencias altamente cohesivas. [línea 7] | ||
| ==== Ejemplo: ==== | ==== Ejemplo: ==== | ||
| Línea 104: | Línea 118: | ||
| 15. $obj = new MiClase(); | 15. $obj = new MiClase(); | ||
| 16. $obj->f1(5, 6, 7); | 16. $obj->f1(5, 6, 7); | ||
| + | </code> | ||
| ---- | ---- | ||
| - | ===== Alineamientos ===== | + | ===== ''Alineamientos'' ===== |
| - | En el caso de un bloque de asignaciones relacionadas se pueden alinear los signos de igualdad (=) . | + | ''En el caso de un bloque de asignaciones relacionadas se pueden alinear los signos de igualdad (=) . '' |
| - | <code> | + | ''''$short = foo($bar); $long_variable = foo($baz); '' '' |
| - | $short = foo($bar); | + | |
| - | $long_variable = foo($baz); | + | |
| - | </code> | + | |
| - | Lo mismo se aplica a las definiciones de arreglos. | + | ''Lo mismo se aplica a las definiciones de arreglos. '' |
| + | |||
| + | ''<code> $some_array = array( '' | ||
| <code> | <code> | ||
| - | $some_array = array( | + | '' 'a' => 'foobar', |
| - | 'a' => 'foobar', | + | 'foo' => 'bar', |
| - | 'foo' => 'bar', | + | 'spam' => 'ham', |
| - | 'spam' => 'ham', | + | |
| - | ); | + | '' |
| </code> | </code> | ||
| + | |||
| + | '' '' | ||
| + | |||
| + | ''); '' | ||
| Las llamadas a funciones se pueden dividir en varias líneas. Los parámetros se identan 1 nivel respecto a la línea de la función a la que pertenecen. | Las llamadas a funciones se pueden dividir en varias líneas. Los parámetros se identan 1 nivel respecto a la línea de la función a la que pertenecen. | ||
ingenieria/estandard-de-codificacion.1401134488.txt.gz · Última modificación: 2016/01/05 23:15 (editor externo)
Herramientas de la página
