Espacio entre la línea-carácter (s) de comentario y el comienzo del comentario real

He desarrollado software en muchos idiomas durante unos 10 años en proyectos grandes y pequeños. Todavía no he visto a nadie intencionalmente no usar un espacio. En el esquema de las cosas, realmente no importa mucho (después de todo, todos sabemos que son comentarios y podemos leerlos), pero creo que la versión sin espacio se parece al código comentado y requiere un milisegundo adicional de potencia cerebral para confirmar que es un comentario: -)

En los últimos 24 años, he desarrollado y mantenido código profesionalmente en C, C++, Pascal, BASIC, Java, Perl, Objective C, Bourne shell, bash, csh, tcsh y assembly para 68K, PowerPC y x86. Durante este tiempo, he notado algunas cosas...

1. Los comentarios con espacios iniciales son al menos 1000 veces más comunes que los comentarios sin espacios. La falta de espacios iniciales en los comentarios son a menudo errores tipográficos debido a la escritura apresurada.

2. No recuerdo haber visto comentarios en código de ejemplo en un libro profesional o manual sin el espacio.

3. Los únicos desarrolladores profesionales que he conocido que omiten rutinariamente el espacio principal en los comentarios crecieron usando un sistema de escritura ideográfica no occidental que no usa espacios.

4. Nunca he visto un estilo oficial de codificación de la compañía que le diga a la gente que omita el espacio principal en los comentarios.

Así que en general, yo diría que la evidencia abrumadora es que un espacio después de la se prefiere el comentario de línea.

Acabo de encontrar la regla SA1005 de StyleCop , que dice:

Una violación de esta regla ocurre cuando un el comentario de una sola línea no comienza con un solo espacio. Por ejemplo:

private void Method1()
{
  //A single-line comment.
  //   A single-line comment.
}

Los comentarios deben comenzar con un solo espacio después de las barras inclinadas:

private void Method1()
{
  // A single-line comment.
  // A single-line comment.
}

Dado que StyleCop es de una manera u otra un producto de Microsoft, yo diría que esto califica como un estándar de codificación oficial con respecto a los espacios en línea-comentarios.

Sobre todo evito tener comentarios al final de una línea de código, porque entonces los comentarios cuelgan al final y no son tan fáciles de analizar al escanear. Sin embargo, cuando tengo una buena razón, me gusta usar dos espacios para separar el código y los comentarios (luego un espacio después del marcador de comentarios). Solo hace que sea más fácil para el ojo...

Considere:

    int top;  // Index of the top of the stack.

Versus:

    int top; // Index of the top of the stack.

Subjetivamente, parece que dos espacios solo hacen que sea más fácil dividir lo que es código y lo que es ni.

Bueno, he encontrado el estándar (según Wikipedia) para comentar en Java. Se supone que esto es "consistente con los estándares Javadoc de Sun Microsystems":

/**
 * Registers the text to display in a tool tip.   The text
 * displays when the cursor lingers over the component.
 * @param text  the string to display.  If the text is null, 
 *              the tool tip is turned off for this component.
 */

Así que estoy empezando a pensar que el estándar es un espacio. Además, todos los otros ejemplos tienen un espacio.

La Guía de estilos de Google C++ requiere dos espacios https://github.com/google/styleguide/blob/gh-pages/cpplint/cpplint.py#L3014 es decir, int foo = 1337 // bar

La Guía de estilo de Google Java Formateo sección requiere poner un espacio en ambos lados de un comentario:

4.6.2 Espacio en blanco horizontal

Más allá de lo requerido por el lenguaje u otras reglas de estilo, y aparte de literales, comentarios y Javadoc, un solo espacio ASCII también aparece solo en los siguientes lugares.

...

1. A ambos lados de la barra doble (//) que comienza un comentario de fin de línea. Aqui, se permiten varios espacios, pero no son necesarios.