Artemonim
@Artemonim

Допустимо ли вести комментарии на нескольких языках сразу?

Допустим, хочу (или нужно) вести комментарии и документацию одновременно на нескольких языках (RUS\ENG).

Чем плох такой подход?
Как это можно делать наиболее оптимально?

У меня в голове есть примерно такое виденье (код на Python)
'''Text output'''
'''Вывод текста'''
print("Hello, World!")
  • Вопрос задан
  • 156 просмотров
Решения вопроса 2
sim3x
@sim3x
Нет, не допустимо
Ответ написан
Комментировать
keydon2
@keydon2
...
Основная причина - так не принято. И в принципе можно наплевать на эту причину.
Но вот количество занимаемого места комментариями это проблема(долго листать, неудобно читать).
Расхождение комментариев(на русском исправили, на инглише забыли или написали противоположное) - это проблема.
Усилия затраченные на дублирование комментария это проблема(вместо одного хорошего грамотного комментария у нас два плохих).
Использование в интернациональном репозитории это проблема(как вам американец пришлет пул реквест с комментариями, если он не знает русского, а если без комментов\на инглише то это расходится по стилю, быстро код превратится в помойку).
Оптимальный комромисс для крупного проекта(для мелкого обычно избыточно) вести отдельно от кода документацию. Есть системы автодокументации, иногда в них и предусматривают локализацию, посмотрите их(не знаю что есть под питон). В любом случае это лишние усилия.
Ответ написан
Комментировать
Пригласить эксперта
Ответы на вопрос 1
Вопрос - зачем? Английский(причем американский) принят во всем мире и учится еще до первой строки кода любым разработчиком(если вы, конечно, не делаете учебные проекты для школьников младших классов). Дублировать на русском - как минимум плохой тон, уменьшающий читабельность кода, уже не говоря о возможных проблемах с кодировками.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы