История изменений

Я как-то работал в конторе, в которой документировать обязаны были *КАЖДУЮ* сущность, включая константы. И код там был в духе

enum my_cool_stuff {
    MY_COOL_ELEM_1 /// This is MY_COOL_ELEM_1
};

/// \brief Put a session.
/// \param session - Session to put.
/// \return Nothing.
///
/// Put a reference to a session. If ref_cnt is zero session is destroyed.
///
void foobar_put_session(const struct session *session);

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

Так что даже не знаю, если честно.

Я как-то работал в конторе, в которой документировать обязаны были *КАЖДУЮ* сущность, включая константы. И код там был в духе

enum my_cool_stuff {
    MY_COOL_ELEM_1 /// This is MY_COOL_ELEM_1
};

/// \brief Put a session.
/// \param session - Session to put.
/// \return Nothing.
///
/// Put a reference to a session. If ref_cnt is zero session is destroyed.
///
foobar_put_session(const struct session *session);

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

Так что даже не знаю, если честно.

Я как-то работал в конторе, в которой документировать обязаны были *КАЖДУЮ* сущность, включая константы. И код там был в духе

enum my_cool_stuff {
    MY_COOL_ELEM_1 /// This is MY_COOL_ELEM_1
};

/// \brief Put a session.
/// \param session - Session to put.
/// \return Nothing.
///
/// Put a reference to a session. If ref_cnt is zero session is destroyed.
///
foobar_put_session(const struct session *session);

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

Так что даже не знаю, если честно.

Я как-то работал в конторе, в которой документировать обязаны были *КАЖДУЮ* сущность, включая константы. И код там был в духе

enum my_cool_stuff {
    MY_COOL_ELEM_1 /// This is MY_COOL_ELEM_1
};

/// \brief Put a session.
/// \param session - Session to put.
/// \return Nothing.
///
/// Put a reference to a session. If ref_cnt is zero session is destroyed.
///
foobar_put_session(const struct session *session);

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

Так что даже не знаю, если честно.