Меня смущает то, что многие люди настаивают на том, что мы должны написать строку документации для каждого класса и метода в Python, в то время как в других языках совет, как представляется, заключается в использовании хорошо выбранных имен методов, чтобы избежать необходимости комментировать.Я предпочитаю просто использовать правильные имена методов, поскольку строка документации часто кажется избыточной.
Я знаю, что строка документации используется IDE для подсказок, но если мне это не нужно, то я не будувижу смысл.Я бы просто делал свое дело, но, занимаясь образованием, я чувствую, что должен дать хороший совет по этому вопросу.
Например, если у меня есть функция, определенная так:
def int_to_bin_string(i):
...
Я не вижу причин добавлять строку документации, описывающую, что она делает.На самом деле это, кажется, нарушает принцип СУХОГО.
Понимание, пожалуйста?