добрый всем день!
пара вопросов-комментариев-прозьб по поводу комментариев к классам, методам, константам в библиотеках Rtads:
1) комментарии на английском было бы хорошо перевести на русский
2) комментарии на русском и английском
например:
#define EC_SUCCESS 0 /* удачное завершение */ /* successful completion */
зачем нужно оставлять английские комментарии? ведь они только громоздят размер библиотеки, ухудшают читабельность кода и навигацию по коду! может быть их поубирать? ведь русской версией библиотек пользоваться то будут только русскочитающие разработчики!!!
Неактивен
Они что, есть просят, эти комментарии? В первый раз слышу чтоб кто-то ругался что комментариев много.
В данном конкретном примере "successful completion" больше говорит о "EC_SUCCESS" чем "удачное завершение" - сразу понятно как произошло и как запомнить название.
Если убирать английские комменты надо менять все названия переменных и функций - например doTake на delaiVziat и т.д. - чтоб комментарии были адекватны. Правда вот ни одна скачанная библиотечка не будет больше работать.
Неактивен
По существу согласен, но педантизьма ради хочу внести еще некоторые уточнения:
goraph написал:
Если убирать английские комменты надо менять все названия переменных и функций - например doTake на delaiVziat и т.д. - чтоб комментарии были адекватны.
Название doTake тогда уж надо менять не на delaiVziat, а на poVziat. Префикс do в данном случае - не английский глагол "делай", а сокращение от "direct object" - прямой объект.
goraph написал:
Правда вот ни одна скачанная библиотечка не будет больше работать.
Если поменять названия методов так, как показано в примере у Горафа, боюсь, ни одна из существующих библиотек не заработает еще очень долго: do и io - зарезервированные системой префиксы методов-обработчиков глаголов, и смена этих префиксов потребует либо вмешательства в исходный код ТАДСа, либо совсем уж немыслимых (и, главное, никому не нужных) измывательств над системными библиотеками.
Неактивен
я не имел ввиду что нужно менять названия методов и классов, я только про комментарии писал!
любое уменьшение размера кода положительно сказывается на читабельности и легкости навигации по нему!
Неактивен
imbeat написал:
любое уменьшение размера кода положительно сказывается на читабельности и легкости навигации по нему!
Вот не надо такой категоричности. Давайте тогда вообще все комменты, отступы и переносы строк удалим, будет раза в 3 меньше.
А ты вообще в курсе что некоторые (я например) читают англицкую документацию (не потому что мне не нравится что напереводил уух, а потому что оригинал это оригинал)? Думаешь легко потом будет переразбиратся в терминологии без комментов? Не говоря уж о том что полного русского мануала пока не существует в природе.
Неактивен