LINUX.ORG.RU

Как написано в стайлгайде проекта.

Ещё неплохой вариант - как угодно, с последующим автоматическим переоформлением.

aedeph_ ★★
()

/** - это маркер, отличающий просто коммент от документации. Больше нигде в теле коммента два астериска не нужны абсолютно.

Кто прав

Некий Уильям Оккам.

E ★★★
()

так

/*
 * Comment here
 * more comment here
 */
vzzo ★★★
()

Какая, твою мать, разница?

Phil Karlton

There are only two hard things in Computer Science: cache invalidation and naming things.

Stil ★★★★★
()

Омг. Ты серьезно спрашиваешь? Как _правильно_?

Второе посимпатичнее но вообще абсолютно пох же.

anonymous
()

Никто не прав, звёдочки вне /* и */ не нужны.

mashina ★★★★★
()
Ответ на: комментарий от kiotoze

Это вообще странно, например VIM (snipMate) делает второй вариант, а другие редакторы/IDE иначе. Понятно, что все это конфижится. Да, подтверждаю — в сишных сорцах в основном первый вариант, в пыховых — второй.

deep-purple ★★★★★
() автор топика

Правильно использовать средство документирования кода, вроде Doxygen, особенно если код является библиотекой.

peregrine ★★★★★
()
Ответ на: комментарий от E

/** - это маркер документации

Ок. Вменяемо.

deep-purple ★★★★★
() автор топика
Ответ на: комментарий от E

Тогда получается это:

/**
 * Comment here
 * more comment here
 **/
документация. Еще разобраться что там в конце одна или две астериски нужны.

А это:

/*
 * Comment here
 * more comment here
 */
просто многострочный комментарий. Тут точно вторая в конце лишняя.

deep-purple ★★★★★
() автор топика
Ответ на: комментарий от deep-purple

собсно это либо для генерации доков либо для IDE
в случае доков понятно, а вот если IDE понимает то:

/**
 * Some function
 *
 * @param $a
 * @param string $b
 * @return bool|string
 */
function blba($a, $b){...}
такие каменты очень помогают при автодополнении и проверке типов передаваемых данных при вызове этой ф-ции где-то там/потом
например

anTaRes ★★★★
()
Ответ на: комментарий от deep-purple

возможно. А может просто этот вариант больше запомнился
А почему для тебя это так важно?

kiotoze ★★★★
()

Пиздец у людей проблемы.

anonymous
()

Я уже джва года ищу ответ на данный вопрос.

anonymous
()
Ответ на: комментарий от deep-purple

Документация - это оба примера из ОП. Вторая в конце лишняя в любом случае. Но для красоты можно добавить.

E ★★★
()
Последнее исправление: E (всего исправлений: 1)
// Комментарии —
// вот так вот
Miguel ★★★★★
()

Оба хуже. Единственная причина существования многострочных комментариев - не отмечать каждую строчку.

/*
Comment here
more comment here
*/

или

//Comment here
//more comment here
anonymous
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.