Se dice que el nombramiento de la capacidad, sino también reflejar el programa de educación básica un programador. Estoy a favor de esta frase! Como desarrollador no puede escapar del nombre de este lugar, tan grande como el nombre del proyecto, nombre del módulo, los nombres de clases pequeñas, nombres de métodos, nombres de los parámetros, los nombres de parámetros, los nombres de variables. El nombre y juega un decisiones clave sobre la calidad y la legibilidad del código.
Cómo código de código de alta calidad? De hecho, el nombre no es tan difícil, la clave de su peso no se presta atención, dispuesto a pasar el tiempo. La siguiente es la elaboración de manuales y por supuesto señala Alibaba en esa parte de la acción aplicable ella.
Notas del curso
-
El tiempo que el nombre más apropiado?
Un principio llamado capaz de expresar con precisión su significado puede ser. Nombre largo puede señalar que no importa.
-
Nombrado para leer, buscar
Aquí que decía, refiriéndose a la necesidad de utilizar alguna rara palabra especial a nombre de Inglés. Realizar búsquedas utilizando herramientas de desarrollo de las funciones de asociación inteligentes. Por ejemplo, escriba la adquisición de un objeto ".Busque", IDE devolverá todos los métodos que comienzan con Get y así sucesivamente. Por ejemplo:
-
El método de obtención de un único objeto con una prefijado Get
-
La adquisición de una pluralidad de métodos de objeto con el prefijo GetList
-
La adquisición de una pluralidad de métodos de objeto con el prefijo GetCount
-
El método de inserción se prefija con Save / inserto
-
método Remove el prefijo Eliminar / Borrar
-
método modificado el prefijo actualización
-
Una función de la cantidad es adecuada?
Una función de unos pocos cientos de líneas, lo que indica qué? La lógica es demasiado complicado, leer el código, es fácil olvidar volver mirado hacia adelante. De hecho, la capacidad de reflejar mejor la lógica y la capacidad para refinar un programador! Para que funcione principio de responsabilidad individual, una división razonable! No somos capaces de cuantificar la función específica del tamaño, la Internet tiene un dicho, que no excedan una altura vertical de la pantalla. Es probable que la función es de aproximadamente 50 líneas.
-
Nota Cómo escribir? Nomenclatura es comentarios importantes, no menos importantes con un nombre. Algunas personas piensan que un nombre bien puede reemplazar el comentario. Personalmente creo que este punto de vista un poco demasiado extrema. Nombrado mejor, después de todo, tienen restricciones de longitud, no se detalla lo suficiente, esta vez, el comentario es un buen suplemento. El propósito es hacer un comentario el código sea más fácil de entender.
Ali desarrollador guía llamado la sección de comentarios (ligeramente modificada)
-
[Obligado] Código de uso prohibido llamado Pinyin mezcla con Inglés, pero no permite el uso directo de la moda china. Descripción: correcta ortografía y la gramática Inglés permite a los lectores fácil de entender, la ambigüedad evitar. Tenga en cuenta que incluso puramente fonética de nombres debe ser evitado.
-
nombres de las clases [obligatorio], nombres de los métodos utilizan el estilo UpperCamelCase, pero las siguientes circunstancias excepcionales: DO / BO / DTO / VO / UID y así sucesivamente.
-
[Obligatorio] nombre del parámetro, variables miembro, las variables locales son de estilo uso lowerCamelCase consistente, deben cumplir con la forma de joroba.
-
[Obligatorio] constante nombrar mayúsculas, separados por un guión entre las palabras, la integridad semántica y se esfuerzan para borrar, nombre no demasiado largo.
-
[Obligatorio] utilizar el nombre Resumen Resumen clase o el comienzo de la Base; clase de excepción llamado usando extremos excepción; clase de prueba lleva el nombre del nombre de su clase a ensayar principio hasta el final de la prueba.
-
[FORZADO] para eliminar por completo las abreviaturas no estándar, lo que significa que no sé para evitar la mirada del texto. Ejemplo anti: AbstractClass "abreviada" nombrado como AbsClass; condición "abreviada" nombrado como condi, tales acrónimo azar degrada seriamente la legibilidad del código.
-
[Recomendado] Si los módulos, interfaces, clases, métodos de uso del patrón de diseño, la necesidad de reflejar el patrón de denominación específica. Descripción: Un patrón de diseño se refleja en el nombre, ayudar al lector a comprender rápidamente el concepto de diseño arquitectónico.
-
[Referencia] enumeración nombre de la clase se recomienda llevar el sufijo Enum, necesita el nombre de miembro de la enumeración de estar en mayúsculas, separados por un guión entre las palabras.
Descripción: La enumeración es en realidad una clase especial, los miembros del dominio son constantes, y se ve obligado a constructor por defecto es privado.
Estatuto de notas
-
[Fuerza] todos los métodos abstractos (incluyendo la interfaz de métodos) Nota, además del valor de retorno, parámetros, las excepciones se ha dicho, hay que señalar que el método para hacer algo, para lograr lo que funciona.
Descripción: alcanzar los requisitos de sub-clase, tampoco todas las precauciones de llamada, por favor, también explica.
-
[Obligatorio] Todas las clases se deben añadir la fecha creador y la creación.
-
[Obligatorio] método interno de los comentarios de una sola línea en la declaración anterior es un comentario en una línea separada, utilizando // comentarios. El método de uso del multi-línea de comentario / * * / comentario interna, y nota que el código está alineado.
-
[Obligatorio] todo el campo de tipo enumerado debe tener una nota sobre el propósito de cada elemento de datos.
-
[Recomendado] con su "a medias" en Inglés a los comentarios, al igual que con la anotación de China se soluciona el problema. Los nombres propios y palabras clave pueden mantener el texto original en Inglés. Counter-ejemplo: "TCP conexión de tiempo de espera" interpretado como "conexión de protocolo de control de transmisión Tiempo de espera agotado", pero obviedad comprensión.
-
[Recomendado] cambios de código al mismo tiempo, los comentarios deben modificarse en consecuencia, en particular, los parámetros, los valores de retorno, anormalidad, la lógica de la base y otras modificaciones. Descripción: Apuntes actualizaciones de código no están sincronizadas, al igual que la red de carreteras y actualización de software de navegación no sincroniza la misma, si el software de navegación está quedando muy por detrás, pierde el sentido de la navegación.
-
[Referencia] Para conocer los requisitos a pie de página: en primer lugar, la reacción se puede diseñar con precisión y lógica del código, en segundo lugar, es decir, capaz de describir el servicio, para que otros programadores a aprender rápidamente el código detrás de la información. No hay comentarios para grandes sectores de la lector de código al igual que los jeroglíficos, el comentario es por sí mismo, aunque separados por un largo tiempo, sino también una comprensión clara en ese momento la idea; Notes también mirar a su sucesor, para que pueda tomar rápidamente sobre su propio trabajo.
-
[Referencia] buen nombre, la estructura del código se explica por sí, los comentarios sean simples y la expresión exacta en su sitio. Para evitar la aparición de un extremo comentarios: Lógica excesivo número de comentarios, de cualquier revisión del código, modificar la nota es una carga considerable.
Por último, hay una muy importante, es decir, proyectos, equipos, e incluso la empresa, hay que formular una norma de codificación unificado, y supervisar la aplicación de la revisión del Código, que tienen un efecto inmediato en la mejora de la calidad del código.
