Правилен начин за коментиране на команди в python

Знам два начина за оставяне на коментари в Python. Единият използва """, а другият използва #. Знам, че първото може да се използва за връщане на помощ за функции като полза. Но кога трябва да използвам едното и кога другото? И също така как трябва да оставям коментари? Трябва ли да натисна tab и да подредя първия ред на коментара с командата под него? Или трябва да започна от началото на реда?


person Cupitor    schedule 23.06.2013    source източник
comment
python.org/dev/peps/pep-0008/#comments   -  person Maxime Chéramy    schedule 23.06.2013


Отговори (1)


Не, има само един начин за коментиране, използвайки # :

Коментарът започва с хеш знак (#), който не е част от низов литерал, и завършва в края на физическия ред.

Тройното цитиране, """, създава обект на низ, който се използва като docstring, когато е първият ред на функция, модул или клас. Тройното цитиране е полезно и на много други места, но не трябва да се бърка с коментирането. Можете да използвате низ в тройни кавички като всеки друг низов литерал, със специфичното предимство, че можете да използвате действителни нови редове във вашия изходен код, вместо да се налага да използвате \n знаци за избягване.

Въпреки че може да се използва за деактивиране на блок от код, като го превърне вместо това в многоредов низ, наистина не трябва да правите това. Използвайте подходящ контрол на изходния код и просто изтрийте блока или използвайте редактор, който ви позволява да коментирате цели блокове, като вместо това вмъкнете # вместо вас.

За действителни коментари използвайте #. Ръководството за стил на Python (PEP 8) има какво да кажете кога и как да използваме коментирането; има какво да каже за отстъпа:

Блоковите коментари обикновено се отнасят за някои (или всички) кодове, които ги следват, и са с отстъп на същото ниво като този код. Всеки ред от блоков коментар започва с # и един интервал (освен ако не е текст с отстъп в коментара).

person Martijn Pieters    schedule 23.06.2013