この世界は。。。いいですか?
Довольно просто:
1. Всегда писать в начале файла комментарий, что это за файл, что он делает и зачем. Особенно в начале заголовочного файла.
2. Такой же комментарий перед каждой функцией.
3. Каждый параметр функции, каждый член структуры, класса, энума должен быть прокомментирован хотя бы одной строкой.
4. Делать всё это по правилам Doxygen.
5. Использовать оный Doxygen как можно чаще.
6. Кто этого не делает, того пороть розгой, лишать премии и он вообще козёл, пусть все знают.
1. Всегда писать в начале файла комментарий, что это за файл, что он делает и зачем. Особенно в начале заголовочного файла.
2. Такой же комментарий перед каждой функцией.
3. Каждый параметр функции, каждый член структуры, класса, энума должен быть прокомментирован хотя бы одной строкой.
4. Делать всё это по правилам Doxygen.
5. Использовать оный Doxygen как можно чаще.
6. Кто этого не делает, того пороть розгой, лишать премии и он вообще козёл, пусть все знают.