На каком языке пишут описание функций в Python?

Question

[weranda]

Приветствую.
Нормально ли писать комментарии на русском языке в docstring функций? Какова практика в РФ?

Comments

[shurshur]

OCS Inventory написан на Perl франкоговорящими. Там и комментарии, и даже названия переменных очень "весело" читать...

[aleks-th]

Если делаешь для себя и никто код не увидит - пиши хоть на суахили...
А если это кому-то нужно будет читать или поддерживать лучше все писать на английском, особенно если это могут быть люди из других стран, чтобы не было проблем.
Ну если 100% никто кроме русскоговорящих не увидит можно и по русски. Но чревато в будущем.

А например китаец возьмет и напишет все по китайски.

半径 = float(input("请输入圆的半径: "))  # 半径 
圆周率 = 3.14159
面积 = 圆周率 * 半径 ** 2

print(f"半径为{半径}的圆的面积是: {面积:.2f}")

Или

def 判断偶数(数字):
    if 数字 % 2 == 0:
        return True
    else:
        return False

输入数字 = int(input("请输入一个数字: "))
if 判断偶数(输入数字):
    print(f"{输入数字} 是偶数")
else:
    print(f"{输入数字} 不是偶数")

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

Answer 1

[Rsa97]

It depends.
Если ожидается, что все, кто будет читать этот код, владеют русским языком, то пишите по-русски.

Answer 2

[Aragorn]

Нормально, но English, конечно, луше. Это стандарт. Так ваш код поймет любой из любой страны.

Answer 3

[Steel_Balls]

На английском.
Я встречался со старыми проектами с комментариями на русском, так там из-за времени кодировки полетели и прочитать ничего невозможно.
Только английский, даже в РФ

Comments

[Алексей 〒.]

Так это не из-за времени, а потому что сохранен скажем в windows-1251 и открывается в utf-8, если подобрать и открыть в правильной кодировке все прочитать можно