Форум — Development Как правильно писать? исходный код, комментарии, форматирование 0 1 Так: /** * Comment here * more comment here */ или так: /** * Comment here * more comment here **/ Кто прав и почему? Ссылка
Как написано в стайлгайде проекта.Ещё неплохой вариант - как угодно, с последующим автоматическим переоформлением. aedeph_ ★★ (23.05.15 15:33:01 MSK) Ссылка
/** - это маркер, отличающий просто коммент от документации. Больше нигде в теле коммента два астериска не нужны абсолютно. Кто правНекий Уильям Оккам. E ★★★ (23.05.15 15:33:33 MSK) Показать ответы Ссылка
Какая, твою мать, разница? Phil Karlton There are only two hard things in Computer Science: cache invalidation and naming things. Stil ★★★★★ (23.05.15 15:35:26 MSK) Ссылка
Омг. Ты серьезно спрашиваешь? Как _правильно_?Второе посимпатичнее но вообще абсолютно пох же. anonymous (23.05.15 15:35:45 MSK) Ссылка
Ответ на: комментарий от kiotoze 23.05.15 16:17:16 MSK Это вообще странно, например VIM (snipMate) делает второй вариант, а другие редакторы/IDE иначе. Понятно, что все это конфижится. Да, подтверждаю — в сишных сорцах в основном первый вариант, в пыховых — второй. deep-purple ★★★★★ (23.05.15 16:22:21 MSK) автор топика Показать ответы Ссылка
Правильно использовать средство документирования кода, вроде Doxygen, особенно если код является библиотекой. peregrine ★★★★★ (23.05.15 16:26:02 MSK) Показать ответ Ссылка
Ответ на: комментарий от E 23.05.15 15:33:33 MSK /** - это маркер документацииОк. Вменяемо. deep-purple ★★★★★ (23.05.15 16:26:53 MSK) автор топика Ссылка
Ответ на: комментарий от anTaRes 23.05.15 16:18:55 MSK Какой нафик пхпдок? deep-purple ★★★★★ (23.05.15 16:27:47 MSK) автор топика Показать ответы Ссылка
Ответ на: комментарий от E 23.05.15 15:33:33 MSK Тогда получается это: /** * Comment here * more comment here **/ документация. Еще разобраться что там в конце одна или две астериски нужны.А это: /* * Comment here * more comment here */ просто многострочный комментарий. Тут точно вторая в конце лишняя. deep-purple ★★★★★ (23.05.15 16:30:33 MSK) автор топика Показать ответ Ссылка
Ответ на: комментарий от deep-purple 23.05.15 16:22:21 MSK собсно это либо для генерации доков либо для IDE в случае доков понятно, а вот если IDE понимает то: /** * Some function * * @param $a * @param string $b * @return bool|string */ function blba($a, $b){...} такие каменты очень помогают при автодополнении и проверке типов передаваемых данных при вызове этой ф-ции где-то там/потом например anTaRes ★★★★ (23.05.15 16:32:30 MSK) Ссылка
Ответ на: комментарий от deep-purple 23.05.15 16:27:47 MSK Какой нафик пхпдок?как пример anTaRes ★★★★ (23.05.15 16:33:18 MSK) Ссылка
Ответ на: комментарий от deep-purple 23.05.15 16:27:47 MSK https://en.wikipedia.org/wiki/Doxygen anTaRes ★★★★ (23.05.15 16:36:30 MSK) Ссылка
Ответ на: комментарий от deep-purple 23.05.15 16:22:21 MSK Странно, я как раз в php и натыкался Zend, Symphony kiotoze ★★★★ (23.05.15 17:37:13 MSK) Показать ответ Ссылка
Ответ на: комментарий от kiotoze 23.05.15 17:37:13 MSK Может, даже если учитывать только пых, ты мало где смотрел? deep-purple ★★★★★ (23.05.15 17:40:17 MSK) автор топика Показать ответ Ссылка
Ответ на: комментарий от deep-purple 23.05.15 17:40:17 MSK возможно. А может просто этот вариант больше запомнилсяА почему для тебя это так важно? kiotoze ★★★★ (23.05.15 18:15:34 MSK) Ссылка
Ответ на: комментарий от deep-purple 23.05.15 16:30:33 MSK Документация - это оба примера из ОП. Вторая в конце лишняя в любом случае. Но для красоты можно добавить. E ★★★ (23.05.15 19:28:45 MSK) Последнее исправление: E 23.05.15 19:28:59 MSK (всего исправлений: 1) Ссылка
Так мне нравится больше: /* * Comment here * more comment here */ iVS ★★★★★ (23.05.15 23:08:41 MSK) Показать ответ Ссылка
Ответ на: комментарий от iVS 23.05.15 23:08:41 MSK Как правильно писать? (комментарий) deep-purple ★★★★★ (23.05.15 23:21:45 MSK) автор топика Ссылка
Оба хуже. Единственная причина существования многострочных комментариев - не отмечать каждую строчку./* Comment here more comment here */ или//Comment here //more comment here anonymous (24.05.15 15:31:39 MSK) Ссылка
Ответ на: комментарий от peregrine 23.05.15 16:26:02 MSK Правильно использовать средство документирования кода, вроде Doxygen, особенно если код является библиотекой.https://ru.wikipedia.org/wiki/Грамотное_программирование - это наше всё anonymous (24.05.15 15:33:29 MSK) Ссылка
Ответ на: комментарий от ovk48 23.05.15 16:44:49 MSK матлаб %{ ... %}или% ... anonymous (24.05.15 15:35:53 MSK) Ссылка