Formato de comentario de encabezado

8

Me doy cuenta de que el formato de "comentario de encabezado" varía de un programador a otro, pero ¿cuál sería un ejemplo de un comentario de encabezado "bueno"?

    
pregunta Mateen Ulhaq 31.03.2011 - 00:29

1 respuesta

4

Con respecto al estilo de formato, es más importante esforzarse por consistencia . Asegúrese de que cada comentario de definición de clase se vea como todos los demás, cada comentario de método se vea como todos los demás, etc.

Por lo tanto, si está modificando el código existente , asegúrese de seguir su estilo de formato. Los comentarios (y, en cierta medida, el código) deben parecer que solo una persona ha trabajado en el archivo. Si está comenzando un nuevo proyecto, elija un formato de estilo y manténgalo.

Lugares para empezar a buscar:

respondido por el Jonathan Khoo 31.03.2011 - 01:53

Lea otras preguntas en las etiquetas