В python мы обозначаем внутреннюю функцию/частные метанды с подчеркиванием в начале. Должны ли эти функции документироваться с docstrings (требуется ли?)? (формальная документация, которую я имею в виду, а не тот, который помогает кодовому считывателю понять код). Что является обычной практикой для этого?
Необходимы ли докстры для внутренних функций (python)?
Ответ 1
Ло, я цитирую из PEP 8, мудрые слова которого следует рассматривать как закон. По этой теме, PEP 8 говорит:
- Записывать docstrings для всех открытых модулей, функций, классов и методы. Докстеллы не нужны для непубличных методов, но вы должен иметь комментарий, который описывает, что делает метод. Этот комментарий должен появиться после строки "def".