¿Qué hacer si un compañero de trabajo está editando su código solo para cambiar la apariencia?

¿Qué debe hacer si un compañero de trabajo está editando su código?

Sin el propósito de agregar funcionalidad o corregir errores, solo para cambiar la apariencia ...

Háblales de ello. Entra en la conversación con la actitud de "No están haciendo esto para molestarme o porque tienen algún tipo de trastorno obsesivo compulsivo; están tratando de mejorar mi código".

Porque podrías estar equivocado. Eso podría ser una solución sutil de errores y simplemente no lo viste.

O bien, podría ser que hay un estándar de codificación que no conoce que está violando, y simplemente lo están corrigiendo.

O podría ser que están tratando de molestarte o que tienen algún tipo de trastorno obsesivo compulsivo. Si ese es el caso, pídales amablemente que se detengan, y si eso no funciona, hable con su jefe.

Pero nunca lo sabrás a menos que lo pidas.

No estoy tan casado con cómo mi código lo busca para molestarme. :) Intento aprender de los cambios. ¿Mi compañero de trabajo ajustó los nombres de las variables? ¿Escribir un bucle más eficiente? ¿Hacer el código más legible?

Si no puedo ver cómo los cambios mejoraron lo que ya estaba allí, generalmente le pregunto al compañero de trabajo que realizó los cambios cuál fue la motivación detrás de ellos. Es posible que la ventaja no sea obvia para mí. Y si tengo razón y están equivocados, entonces quizás pueda explicar por qué lo escribí de la manera en que lo hice.

Si todo lo demás falla, revierta el check-in. ;)

Editar: Sin embargo, todas las apuestas están canceladas si el deseo de hacer cambios cosméticos introdujo un error.

En mi opinión, tú y tu equipo deberían usar un estándar de codificación de todos modos. Si este es el caso, entonces las preguntas se convierten en '¿se ajustó su código original al estándar?' En caso afirmativo, su colega no debería tocar su código a menos que lo cambie funcionalmente. En caso negativo, me temo que su colega tiene todo el derecho de ordenar su código. Como líder de proyecto, me encuentro haciéndolo todo el tiempo.

Si no está utilizando un estándar de codificación, entonces todo el argumento de lo que constituye 'buen código' se vuelve demasiado subjetivo. Por lo tanto, por qué debería usar un estándar de codificación :)

Como una de esas personas (las personas que ocasionalmente reformatean el código de otras personas), la razón principal por la que lo hago es la legibilidad. Algunas personas son extremadamente descuidadas con su sangría o con la combinación de pestañas y espacios.

Lo principal que tengo la costumbre de cambiar es reducir las líneas largas para que pueda leer todo sin desplazamiento horizontal. Dividiré las declaraciones complejas en declaraciones separadas o las llamadas / declaraciones de método de reformateo para enumerar un parámetro por línea si no cabe todo cómodamente en una sola línea. También editaré comentarios, ya sea para corregir errores en inglés o simplemente para aclarar las cosas.

Sí, podría dejarlo solo, pero preferiría reducir el esfuerzo mental requerido para leer el código.

Que deberias hacer al respecto? En primer lugar, considere que tal vez esta persona está mejorando su código. Además, debe asegurarse de tener cierto consenso en su equipo sobre cómo se debe formatear el código. Si cada persona tiene hábitos diferentes, retrasará a todos. Si no están mejorando su código y van contra la corriente, entonces debe confrontarlos al respecto. Si eso no funciona, entonces es posible que deba involucrar a otros.

Pregúnteles por qué lo están haciendo; Una explicación válida puede disminuir su frustración, pero debe hacerles saber cuánto le molesta. Quién sabe, tal vez pensaron que te estaban haciendo un favor y se detendrán cuando sepan que te ofende. O puede estar tratando con alguien que realmente padece una afección médica.

¿Está permitido? ¿Los cambios mejoran el código? Si es así, trágate tu orgullo. Si cree que la calidad del código ha empeorado, hable con el compañero de trabajo y pregúnteles por qué sintieron la necesidad de cambiar su código sin ningún beneficio obvio. Si se hace por despecho o porque la persona, por error, siente que es mejor que tú y no puedes resolverlo con ellos, habla con tu jefe.

Los IDE como Visual Studio tienen una opción llamada Format Documentque formateará el código de acuerdo con las reglas que el usuario ha establecido en el IDE. Podría ser que su compañero de trabajo esté usando esto (ya sea automáticamente sin saberlo o mediante una aplicación deliberada). ¿Quizás su IDE usa espacios en lugar de pestañas, o viceversa, y estos se aplican automáticamente sin siquiera saberlo? Pero necesitas hablar con ellos para averiguarlo.

Por cierto, a menudo volveré a formatear el código de los compañeros de trabajo si obviamente no sigue algún tipo de esquema de formateo (es decir, está por todas partes). Es una forma, con suerte, sutil de hacerlos notar. (Sin embargo, no lo reformatearía si fuera ordenado, pero no es de mi agrado).

Si lo está cambiando para que cumpla con los estándares de codificación de su equipo, debe seguir los estándares la próxima vez.

Si lo cambia de modo que ya no siga los estándares de codificación de su equipo, infórmele qué está haciendo mal y pídale que lo vuelva a cambiar.

... Su equipo tiene un conjunto de estándares de formato de código que son utilizados por todos, ¿verdad?

Ocasionalmente, reordena el código escrito por compañeros de trabajo desordenados (o corrijo errores tipográficos en los comentarios). Saben que soy obsesivo con el formato y el orden del código y, por lo tanto, me dejan hacerlo sin quejarme demasiado. A veces también me dan un refresco o una galleta gratis.

Por supuesto, este es un trabajo ocasional , ya que rompió la funcionalidad de "culpa" en SVN.

Esta también es una forma muy básica de hacer algún tipo de revisión de código (generalmente leo la mayoría del código comprometido por mis compañeros de trabajo en los módulos en los que estoy trabajando).

Las convenciones de código es la respuesta. Deberías tener uno en el trabajo. Si no lo hace, comience ahora mismo (un buen punto de partida es la guía de estilo de Google ). Cuando hay reglas escritas (o al menos comúnmente conocidas), la respuesta a su pregunta es trivial.

Siento que estás pensando que es ofensivo hacerlo ... Por ejemplo, yo mismo arreglaría este código inmediatamente

int myFunction( ) {

    int i ;
  return  0;

}

convertirse

int myFunction() {
    int i;
    return 0;
}

entonces ... ¿debería ser castigado por mi acción? En la vida real, tengo toneladas de registros SVN que dicen 'Formateo'. ;-)

Use una herramienta de verificación de estilo

Comience a usar StyleCop o similar y aplique reglas de estilo de código y también obligue a todos los desarrolladores a usarlo. Todo el código se verá igual sin excepción. Y reúnase con los sabios para discutir las reglas más apropiadas para su organización. A pesar de que las reglas predeterminadas ya son muy similares al código .NET Framework.

Es la forma más fácil de hacerlo. Me encontré corrigiendo el código de otra persona en uno de mis empleadores anteriores porque este otro tipo estaba escribiendo código con cantidades excesivas de líneas vacías y sin reglas de sangría. El código era realmente ilegible por un desarrollador promedio. Si StyleCop existiera entonces, nos haría felices a muchos de nosotros.

Este es un pensamiento que vi en Internet hablando de refactorización y tal vez explique por qué alguien tocaría su código para mejorarlo:

¿Por qué?

Hay dos razones principales para refactorizar:

1. Para mejorar el código / diseño antes de construir en su parte superior: es realmente difícil encontrar un buen código en el primer intento. El primer intento de implementar cualquier diseño inicial nos mostrará que hemos malinterpretado u olvidado alguna lógica.

2. Para adaptarse a los cambios en los requisitos. El cambio ocurre en el desarrollo de software; Para responder al cambio es mejor tener una buena base de código. Tenemos dos opciones para ambos escenarios, ruta del código o refactorizarlo. Parchear el código nos llevará a un código que no se puede mantener, y aumentará nuestra deuda técnica, siempre es mejor refactorizar.

¿Cuando?

1. Cuanto antes mejor, más fácil es.

2. más rápido y menos arriesgado refactorizar sobre un código refactorizado recientemente en lugar de esperar a refactorizar para que el código esté casi completo.

¿Qué?

1. Todo el código y todo el diseño son candidatos para la refactorización.

2. Una excepción para no refactorizar algo podría ser un código de trabajo cuya calidad es baja, pero debido a que está cerca de una fecha límite, preferimos mantener nuestra deuda técnica en lugar de arriesgar la planificación.

¡Solo tiene que dejar que haga lo mejor que pueda, si sería genial para ambos y le ahorraría tiempo en el futuro!

salud