Lo que generalmente aceptados código de pautas de formato?

Question

De acuerdo a McCall del Modelo de Calidad, Producto De La Revisión es uno de los tres principales perspectivas para la descripción de los atributos de calidad de un producto de software.Bajo el Producto de la Revisión de la perspectiva, mantenimiento, la capacidad para localizar y corregir un defecto, es identificado como un factor clave de calidad que afecta la capacidad de modificar el software.

Claramente, en algún momento en el proceso de revisión, hay una necesidad de intervención humana, específicamente programador de participación.El formato del código tiene un impacto en el programador de la capacidad de modificar el software de forma eficaz y eficiente.

Lo que generalmente aceptados, independiente del idioma código de pautas de formato ha trabajado con las que maximizar el programador de la eficiencia y la eficacia en la revisión del código de proceso?

Answer 1

Las mejores guías que he trabajado es la consistencia.A través de los años he usado un montón de estilos diferentes, con diferentes equipos ...los mejores resultados que he visto es que todo el equipo está obligado a utilizar el mismo estilo, independientemente de cual sea tu estilo :-)

Answer 2

Tengo un par de ideas sobre algunos independiente del idioma conceptos:

1.) Quitar código muerto.A menos que algo es absolutamente esencial, comentada, de código muerto debe ser eliminado.Se satura una rutina, usted conseguirá a menudo falsos positivos cuando usted busca algo de cuerda y muestra una general falta de cuidado que no es bueno para un desarrollador profesional

2.) Para las revisiones de mantenimiento, hacer referencia a un defecto de número de seguimiento en un comentario--asumiendo que usted tiene algún tipo de defecto del sistema de seguimiento.Esto hace que sea más fácil para cualquier persona mantener su trabajo de averiguar por qué el código ha cambiado entre una versión y otra.

3.) Para los idiomas que soportan, declarar variables tan cerca como sea posible de su primer uso.

Estoy seguro de que hay un par de otros idiomas conceptos, pero estos son los primeros que vienen a la mente.Hasta donde yo sé, es relativamente difícil hablar de estándares de codificación en ausencia de un lenguaje específico.Y estoy de acuerdo con las otras respuestas anteriores-el mejor estilo es generalmente la que más combina a la perfección con el estilo existente.

Puede que desee echar un vistazo a Steve McConnell del El Código Completo.Está lleno de buenas ideas que debe ser aplicable en casi cualquier situación de desarrollo, independientemente del lenguaje de programación.

Answer 3

La consistencia es la clave.Anote las directrices en algún lugar, y requieren la conformidad.

Formato del código es que no vale la pena preocuparse, ni a discutir.Acabo de hacer algunas reglas, y se adhieren a ellos.

Answer 4

Estoy de acuerdo con Joel.Hay muchos ejemplos de estilo por ahí;la mayoría son buenos.Algunos no son tan útiles como los demás (notación húngara?) ya.El punto es la coherencia, aunque.Mientras un nuevo desarrollador puede entrar y comprender el código de inmediato en lugar de tener que acostumbrarse a cada desarrollador del estilo personal, funciona.

La conmutación de los estándares de cada año o así que es probablemente una mala idea.

Answer 5

Estoy de acuerdo con Joel, la facilidad de mantenimiento aumenta considerablemente cuando se tiene la consistencia dentro de su organización.Si yo unirse a otro equipo de el tiempo de rampa es mucho menos si todo tiene un aspecto similar a la actual de mi porque puedo leer el código mucho más rápido w/out todo el interior "cambio de contexto" para conseguir mi cabeza alrededor de ", por lo que el uso mVar en lugar de _var" / etc

Answer 6

Uno de los grandes estándares que tenemos es la variable "prefijo".Hasta que llegué aquí, me gustaría principalmente escrito en solitario así que no te preocupes.

Estamos "obligados" a nombre de las variables con los prefijos que indican lo que son.Por lo tanto, saber al instante cuando se mira en dpVarName que es un puntero a un doble, y que lVarName es un long int.

Yo estaba contento de que en la primera que nos dieron dos opciones de horquillado de bloques, pero ahora me gustaría que eran todos forzado a hacerlo de una manera o de la otra.