singlepost

Язык документирования кода << На главную или назад  

Господа, как вы считаете, на каком языке нужно документировать код?
Должен ли это быть обязательно английский, ибо кто знает какая судьба ждет код. Или можно обойтись русским если на данном этапе вся команда говорит по-русски.
Или код и так неплохо документируется на языке С++? ;)
На каком языке документируете код вы?

58 ответов в теме “Язык документирования кода”

  1. 22
    Дмитрий Правдюк ответил:

    //ru.wikipedia.org/wiki/Doxygen + English

    Преимущества очевидны.

  2. 21
    Игорь Голов ответил:

    English only. As a language for International communications.
    Ну вы поняли, короче.))))))))

  3. 20
    Леонид Максимов ответил:

    буквально через пару месяцев такого непродуктивного чтения оно перейдет в нормальное, а затем и в обычное. это гораздо проще, чем воспринимать транслит.

  4. 19
    Нгамдкхе Кверос ответил:

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

    это не только моё мнение, если почитать соответствующую литературу она о том же говорит.

  5. 18
    Расул Фазлыев ответил:

    #9. А женщинам что отрывают? )

  6. 17
    Павел Потапов ответил:

    Английский – термины на нем лучше выглядят… а на двух писать – зло :)

  7. 16
    Николай Митропольский ответил:

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

    > причём если родной то писать лучше транслитом на случай перенесения кода

    Ну я все же верю в UTF )

    А может быть имеет смысл вести док на двух языках, на родном и на английском?

  8. 15
    Расул Фазлыев ответил:

    Транслит не люблю – неудобно. Английский проще читать, хотя у меня уровень знания языка невысокий.

  9. 14
    Расул Фазлыев ответил:

    Кстати, знает кто-нибудь, есть в группе специальная тема для всякого бреда? Если нет, то можно создать. Видел подобное в одной группе. Тема называлась "Таверна". Но все эти таверны обычно являются форумными рпг.

  10. 13
    Нгамдкхе Кверос ответил:

    в идеале код должен быть максимально прозрачен. чем меньше требуется пояснений тем лучше.
    язык нужно брать или родной(для вас и нынешней основной команды разработчиков) или английский, причём если родной то писать лучше транслитом на случай перенесения кода.
    родной язык обычно лучше и работается быстрей, потому если проект не требует выхода исходников за пределы одноговорящей комманды лучше писать на родном.

  11. 12
    Леонид Розенблюм ответил:

    На английском – так как это де-факто стандарт. Общаться потом по коду с программистами других стран проще.

  12. 11
    Жека Кирпичев ответил:

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

  13. 10
    Евгений Гаврин ответил:

    Вот чего не знаю – того не знаю.

  14. 9
    Расул Фазлыев ответил:

    На польском? С диакритиками?

  15. 8
    Евгений Гаврин ответил:

    А на другом этапе вам понадобится общаться с поляками – будете переписывать старые и писать новые на польском?

    Английский.

    Правда есть у меня приятель один – так он фанатично коментит все на польском, правда за такое обычно отрывают те две штучки, что у мужиков между ног болтаются.

  16. 7
    Владимир Муромский ответил:

    чего-чего, вот этого самого)

  17. 6
    Расул Фазлыев ответил:

    ×åãî?

  18. 5
    Андрей Юткин ответил:

    Я документировал на английском даже курсовики в универе )

  19. 4
    Макс Донцов ответил:

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

  20. 3
    Расул Фазлыев ответил:

    Я – на английском, потому что зачастую пользуюсь системами, не понимающими кириллицу.

  21. 2
    Расул Фазлыев ответил:

    Вот-вот. Konqueror тупит )

  22. 1
    Владимир Муромский ответил:

    Расул показал, что бывает, если неправильно выбрать язык документации.

    upd: эх, больше этого никто не увидит.

Клуб программистов работает уже ой-ой-ой сколько, а если поточнее, то с 2007 года.