В крутых фирмах, наверное, все всё пишут как положено. У них и код ревью есть. И стандарты оформления кода.
Я, увы, привык писать по-колхозному, грязно и быстро. Тем не менее, после этого огребаешь. Написание документации... ну, это НЕ необходимость, но в ней есть один прикол. Документацию пишешь один раз, это довольно быстро. А помогает она много раз. И экономит время КАЖДЫЙ раз, когда к ней обращаешься.
Документацию я делаю в DOxygen, т.е. вписываю сразу в исходники. Часть модулей у меня документирована, а часть -- нет. И вот что я заметил. Если видишь, что в модуле всё документировано, то... как-то стыдно становится для новой функции не писать документацию. Поэтому её сразу пишешь. Ну а если в модуле ничего не документировано -- то и не начнёшь. Лень же!
То есть, главное -- начать.
Я, увы, привык писать по-колхозному, грязно и быстро. Тем не менее, после этого огребаешь. Написание документации... ну, это НЕ необходимость, но в ней есть один прикол. Документацию пишешь один раз, это довольно быстро. А помогает она много раз. И экономит время КАЖДЫЙ раз, когда к ней обращаешься.
Документацию я делаю в DOxygen, т.е. вписываю сразу в исходники. Часть модулей у меня документирована, а часть -- нет. И вот что я заметил. Если видишь, что в модуле всё документировано, то... как-то стыдно становится для новой функции не писать документацию. Поэтому её сразу пишешь. Ну а если в модуле ничего не документировано -- то и не начнёшь. Лень же!
То есть, главное -- начать.
01.02.2022 в 04:27
на улицах, где разбиты витрины и лампочки, чаще мусорят и совершают преступления )))