Пространство между символом (символами) комментария строки и запускается фактического комментария

Я разрабатывал программное обеспечение на многих языках около 10 лет для больших и малых проектов. Я еще не видел, чтобы кто-нибудь намеренно не использовал пространство. В схеме вещей это не так уж важно (в конце концов, мы все знаем, что это комментарии, и можем их читать), но я действительно думаю, что версия без пробела похожа на закомментированный код и требует дополнительной миллисекунды. умственных способностей, чтобы подтвердить, что это комментарий: -)

За последние 24 года я профессионально разработал и поддерживал код на языках C, C ++, Pascal, BASIC, Java, Perl, Objective C, оболочке Bourne, bash, csh, tcsh и сборка для 68К, PowerPC и x86. За это время я заметил несколько вещей ...

1. Комментарии с начальными пробелами встречаются как минимум в 1000 раз чаще, чем комментарии без пробелов. Отсутствие начальных пробелов в комментариях - это чаще всего опечатки из-за поспешного набора.

2. Я не могу припомнить, чтобы когда-либо видел комментарии в образце кода в профессиональной книге или руководстве без пробелов.

3. Единственные известные мне профессиональные разработчики, которые регулярно пропускать начальный пробел в комментариях вырос с использованием незападной идеографической системы письма, в которой пробелы не используются.

4. Я никогда

Well I have found the standard (according to Wikipedia) for commenting in Java. This is supposed to be "consistent with the Sun Microsystems Javadoc standards":

/**
 * 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.
 */

So I'm starting to think the standard is a space. Also, all the other examples have a space.

Я обычно избегаю комментариев в конце строки кода, потому что в этом случае комментарии свисают с конца и их не так легко проанализировать при сканировании. Однако, когда у меня есть веская причина, я люблю использовать два пробела для разделения кода и комментариев (затем один пробел после маркера комментария). Это просто облегчает восприятие ...

Подумайте:

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

против:

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

Субъективно кажется, что два пробела просто упрощают разделение того, что код, а что нет.

Я только что наткнулся на правило StyleCop SA1005 , которое гласит:

Нарушение этого правила происходит, когда однострочный комментарий не начинается с единым пространством. Например:

 private void Method1 ()
{
 // Однострочный комментарий.
 // Однострочный комментарий.
}

Комментарии должны начинаться с одного пробела после косой черты в начале:

 private void Method1 ()
{
 // Однострочный комментарий.
 // Однострочный комментарий.
}

Поскольку StyleCop так или иначе является продуктом Microsoft, я бы сказал, что это квалифицируется как официальный стандарт кодирования в отношении пробелов в строковых комментариях.