Переменная документа в python

Если в середине моего программного обеспечения у меня есть эта переменная, мне нужно объяснить, что это такое и для чего используется, мне нужна документальная переменная.Переменная документа в python

У меня есть опыт в JS, так что это, как я делаю:

/** 
* Explain what the variable is, and what is for. 
* @variable {Object} nameOfVariable 
*/ 
var nameOfVariable = []

В случае питона:

# ?? 
name_of_variable = []

Есть соглашения для такого рода вещи?

Большое спасибо.

источник

2016-12-15 Anonymous

Из моего опыта, я обычно документ функции с строки документации, но если вы хотите, чтобы документировать переменную, вы можете использовать '' # последовательно строки, пока вы не это документально. Я хотел бы обратиться к https://www.python.org/dev/peps/pep-0008/#comments –

http://effbot.org/zone/pythondoc.htm – mplungjan

-1

Вы можете обнаружить, что люди документ параметров, какие функции возвращает, и так далее, но, как правило, переменные не документированы в библиотеках питона.

Имена, как правило, не требуют пояснений.

источник

2016-12-15 12:06:13

Да, есть - это то, что я могу найти

https://www.python.org/dev/peps/pep-0257/

Для функций, которые вы можете добавить строку документации, например,

def some_function(): 
    """ Write here a one line summary. 

If wanted, then leave a line and write a more detailed one"""

""" необходимо отступом правильно работать

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

some_variable = Something # This variable is doing this...

Надеюсь, что это немного полезно.

источник

2016-12-15 12:07:15

Что делать, если мне нужен документ типа переменной? –

При написании встроенного комментария не забудьте поставить как минимум два пробела перед '#'. –

Я думаю, что следующие вопросы и ответы помогут вам: http://stackoverflow.com/questions/7690220/how-to-document-python-function-parameter-types и http://stackoverflow.com/questions/3051241/ как к документарно- класса-атрибуты-в-питон –

PEP257 документы, так называемые docstrings, который является строковым литералом, который представляется в качестве первого утверждения в определении модуля, класса, функции или метода. Насколько я знаю, если вы хотите оставить некоторую информацию о переменной, вы оставляете рядом с ней регулярные комментарии. Например:

# This is some variable ... 
some_variable = ...

источник

2016-12-15 12:08:58 Nurjan

Переменная документа в python

ответ

Смежные вопросы