Formato de comentario de encabezado

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

En cuanto al estilo de formato, la consistencia es más importante para luchar. Asegúrese de que cada comentario de definición de clase se parezca a todos, cada comentario de método se parezca a todos, etc.

Entonces, si está modificando el código existente , asegúrese de seguir su estilo de formato. Los comentarios (y, hasta cierto punto, el código) deberían verse como si solo una persona hubiera trabajado en el archivo. Si está comenzando un nuevo proyecto, elija un formato de estilo y manténgalo.

Lugares para comenzar a buscar:

• Guías de estilo de Google (C ++, JavaScript, Objective-C y Python)
• Ejemplo de comentario de Oracle JavaDoc