Здравствуйте, blackhearted, Вы писали:

B>Здравствуйте, LaptevVV, Вы писали:

_>>>эээ, и там и там автодополнение есть, какая разница в чём код писать? я же не про логику, я про стилистику и оформление.
LVV>>Мне подсказки в Студии — мешают. Я и так знаю, что хочу набрать.

B>just google "как выключить intellisense" парам_пам_пам
Ну дык!

Откройте же для себя doxygen

Здравствуйте, Sheridan, Вы писали:

S>Откройте же для себя doxygen

И что он принципиально меняет?

Приветствую, netch80, вы писали:

n> Здравствуйте, Sheridan, Вы писали:

n> S>Откройте же для себя doxygen

n> И что он принципиально меняет?
Генерирует документацию из ничего практически. А если еще документировать в его стиле — то очень красиво выходит.

Здравствуйте, Sheridan, Вы писали:

n>> S>Откройте же для себя doxygen

n>> И что он принципиально меняет?
S>Генерирует документацию из ничего практически. А если еще документировать в его стиле — то очень красиво выходит.

Данный тред посвящён комментариям к тому, что и как делается в коде, а не тому, как описать его деление на функции. Doxygen и аналоги обсуждаемому здесь полностью ортогональны.

Здравствуйте, Sheridan, Вы писали:

n>> И что он принципиально меняет?
S>Генерирует документацию из ничего практически. А если еще документировать в его стиле — то очень красиво выходит.

Если документация нужна, чтобы отчитаться перед начальством, что она есть, доксиген — прекрасная тулза. Если же документация пишется для людей, чтобы они ее читали, доксиген идет лесом.

Здравствуйте, Sheridan, Вы писали:

n>> И что он принципиально меняет?
S>Генерирует документацию из ничего практически. А если еще документировать в его стиле — то очень красиво выходит.
Полная жуть порой выходит.

Иногда не обойтись без комментариев типа "тут мы делаем затык чтобы обойти баг в АПИ такой-то"

Приветствую, netch80, вы писали:

n> Данный тред посвящён комментариям к тому, что и как делается в коде, а не тому, как описать его деление на функции. Doxygen и аналоги обсуждаемому здесь полностью ортогональны.

Я к тому, что если решите документировать, то документируйте с доксигеном.

Приветствую, Pzz, вы писали:

Pzz> Если же документация пишется для людей, чтобы они ее читали, доксиген идет лесом.
Ты не умеешь, видимо, готовить. Или не осилил, хотя там осиливать нечего. Или лень тебе.
Вот такая телепатия.

Здравствуйте, Sheridan, Вы писали:

Pzz>> Если же документация пишется для людей, чтобы они ее читали, доксиген идет лесом.
S>Ты не умеешь, видимо, готовить. Или не осилил, хотя там осиливать нечего. Или лень тебе.
S>Вот такая телепатия.

Никто не умеет. Ты, просто, нормальной документации не видел.

Приветствую, Pzz, вы писали:

Pzz> Никто не умеет. Ты, просто, нормальной документации не видел.
Ну вот я сейчас как раз изучаю. Ибо достало по коду прыгать вперед-назад. Группы рулят например.

Здравствуйте, Sheridan, Вы писали:

S>Приветствую, Pzz, вы писали:

Pzz>> Если же документация пишется для людей, чтобы они ее читали, доксиген идет лесом.
S>Ты не умеешь, видимо, готовить. Или не осилил, хотя там осиливать нечего. Или лень тебе.
S>Вот такая телепатия.

Моя телепатия говорит, что ты или тупо троллишь, или с утра забыл, что кроме документации-справочника существует множество других видов документации. Да и справочник из doxygen, мягко говоря, односторонний, там даже расшифровки содержания enum'а не будет.

Приветствую, netch80, вы писали:

n> Моя телепатия говорит, что ты или тупо троллишь, или с утра забыл, что кроме документации-справочника существует множество других видов документации.
Твоя телепатия не смогла определить что в этой ветке разговор именно про doxygen. Специально для тебя я даже ветку поименую.

n> Да и справочник из doxygen, мягко говоря, односторонний, там даже расшифровки содержания enum'а не будет.
Мсье, вы прямо таки не знаете о чем говорите.

//! Оверлеи
enum EOverlays
{
    oNew,            //!< Новое...
    oTag,            //!< Метка
    oEdit,           //!< Редактирование
    oLocal,          //!< Локальное действие
    oRemove,         //!< Удаление
    oIncoming,       //!< Входящее...
    oOutgoing,       //!< Исходящее...
    oWriteOff,       //!< Списание
    oNewWindow,      //!< Новое окно
    oCommission      //!< Коммиссия
};

[Картинка 200'318 байт]

И описания не только тут присутствуют, но и хинтом везде.

[Картинка 280'356 байт]

Приветствую, art_kuz, вы писали:

a> Требования например у нас такие комментрии в doxygen, так как генериться портал с документацией, иногда помогает.
a> Используется стиль с++, т.е. никаких /* */.
Почему бы не

/**
*/

или

/*!
*/

а в коментариях с++ как?

///

или

//!

Здравствуйте, Sheridan, Вы писали:

S>Приветствую, art_kuz, вы писали:

a>> Требования например у нас такие комментрии в doxygen, так как генериться портал с документацией, иногда помогает.
a>> Используется стиль с++, т.е. никаких /* */.
S>Почему бы не
S>

/**
S>*/

S>или
S>

/*!
S>*/

S>а в коментариях с++ как?
S>

///

S>или
S>

//!

Никак не пойму — ради чего эта болтология?
Забыли смысл слова "РАЗУМ" вообще?
Или эта часть мозга отнялась?
Может Вы в курсе?

Приветствую, RealBobEx, вы писали:

RBE> Никак не пойму — ради чего эта болтология?
RBE> Забыли смысл слова "РАЗУМ" вообще?
RBE> Или эта часть мозга отнялась?
RBE> Может Вы в курсе?

Болтология у тебя. Я задал вполне нормальный вопрос, ибо мне а) интересны корни решения и б) что означает "стиль с++"

Следующий.

Здравствуйте, Sheridan, Вы писали:

S>Приветствую, netch80, вы писали:

n>> Моя телепатия говорит, что ты или тупо троллишь, или с утра забыл, что кроме документации-справочника существует множество других видов документации.
S>Твоя телепатия не смогла определить что в этой ветке разговор именно про doxygen. Специально для тебя я даже ветку поименую.

Моя телепатия говорит, что ты влез с темой про doxygen туда, где он нафиг не нужен, и пытаешься теперь внушить, что тут якобы "эта ветка" с отдельной темой, хотя её тут не было и она там не нужна.

n>> Да и справочник из doxygen, мягко говоря, односторонний, там даже расшифровки содержания enum'а не будет.
S>Мсье, вы прямо таки не знаете о чем говорите.
S>//! Оверлеи
S>enum EOverlays
S>{
S> oNew, //!< Новое...
S> oTag, //!< Метка

Слабо. Для нормальной расшифровки такой попунктный список недостаточен.

Вернёмся к исходной теме. Каким образом, по-твоему, doxygen сможет сделать адекватный эквивалент обычным замечаниям в коде типа "здесь используется модифицированная версия алгоритма Зенона-Мбонга-Пупкина, потому что она показала лучшую устойчивость на нашем профиле данных"? Выносить это в заголовок описания функции не предлагать: таких мест может быть с десяток, и искать связи какой-то ерунды в заголовке с кодом никто не будет. Если не сможет — ты его приплёл без толку.

Приветствую, netch80, вы писали:

n> Моя телепатия говорит, что ты влез с темой про doxygen туда, где он нафиг не нужен, и пытаешься теперь внушить, что тут якобы "эта ветка" с отдельной темой, хотя её тут не было и она там не нужна.
Твоя телепатия не телепатия, так как до нее не дохордит, что я поднял ветку специально.

n> Слабо. Для нормальной расшифровки такой попунктный список недостаточен.
Так и будем вещать, типа "твое конфу слабее моего" из своего темного уголка или выйдешь на свет белый и покажешь всетаки?

n> Вернёмся к исходной теме.
Не хочу. Хочу поговорить про доксиген.

LVV>>>Не, не люблю писать длинно...

S>>Это "длинно" будет всяк короче длины твоих комментариев в коде.
LVV>Уже объяснял, что имена переменных сохранены специально (из прежней проги), чтобы заказчику было проще ориентироваться. А коммент — уже мой — для себя и для него.

С этого надо было начинать А то "я не люблю длинно писать" и т.п. — это неконструктивно