Часто мне нужно временно прокомментировать какой-то код, но бывают ситуации, подобные следующей, когда комментирование одной строки кода приведет к синтаксической ошибке.
if state == False:
print "Here I'm not good do stuff"
else:
# print "I am good here but stuff might be needed to implement"
Есть ли что-то, что может действовать как NOOP, чтобы сохранить правильный синтаксис?
Искомая операция pass. Итак, в вашем примере это будет выглядеть так:
if state == False:
print "Here I'm not good do stuff"
else:
pass
# print "I am good here but stuff might be needed to implement"
Подробнее об этом можно прочитать здесь: http://docs.python.org/py3k/reference/simple_stmts.html#pass
В Python 3 ... является довольно хорошей заменой pass:
class X:
...
def x():
...
if x:
...
Я прочитал это как «необходимо сделать», тогда как pass означает «эта страница намеренно оставлена пустой».
На самом деле это просто литерал, очень похожий на None, True и False, но они все равно оптимизируются.
Я обнаружил, что если вы поместите код в комментарий с тройными кавычками '''comment''', он действует как NOOP, поэтому вы можете поместить комментарий с тройными кавычками, который будет действовать как NOOP в случае, если код будет удален или прокомментирован с помощью #.
Для приведенного выше случая:
if state == False:
'''this comment act as NOP'''
print "Here I'm not good do stuff"
else:
'''this comment act as NOP and also leaves the
else branch visible for future implementation say a report or something'''
# print "I am good here but stuff might be needed to implement"
pass — это правильный путь, потому что он был создан для этой ситуации. Если вы используете комментарии таким образом, вы нарушаете правило комментариев: их можно удалить без изменения семантики программы.
- person Nobody moving away from SE; 18.09.2012
1+1, скажем -- дело в том, что pass уже означает ничего не делать, чтобы кто-то другой, читающий код, понял, что он ничего не делает.
- person Katriel; 18.09.2012
def или class или в начале модуля и, таким образом, не являются строками документации, doctest игнорирует эти строки.
- person unutbu; 18.09.2012
