Spousta porušení PEP 8 nadměrnou délkou řádku (E501) je způsobena příliš dlouhým, nebo nevhodně umístěným komentářem. Samotný standard říká:
Use inline comments sparingly.
Doporučuji projít aspoň tyto dlouhé, ne-li všechny: není jich zas tolik. Naprostou většinu lze přesunout na samostatný řádek a může to být vhodné i v případě těch kratších, co se vejdou. Příliš dlouhé na samostatném řádku je třeba zkrátit, nebo rozdělit na více řádků.
Některé komentáře jsou zcela zbytečné, nebo neužitečné. Nejhorší jsou takové, jež neodpovídají skutečnosti. Takové je třeba buď nahradit lepšími, nebo zcela odstranit. To může proběhnout zvlášť – nejdřív vyřešit pouze formátování a potom až obsah.
Úkoly či jiné věci k vyřešení bývá dobré označit klíčovým slovem. Buď TODO, nebo FIXME, případně se zavináčem (@TODO). To umožňuje je snadno všechny najít a vývojová prostředí s nimi často umí pracovat.
Spousta porušení PEP 8 nadměrnou délkou řádku (E501) je způsobena příliš dlouhým, nebo nevhodně umístěným komentářem. Samotný standard říká:
Doporučuji projít aspoň tyto dlouhé, ne-li všechny: není jich zas tolik. Naprostou většinu lze přesunout na samostatný řádek a může to být vhodné i v případě těch kratších, co se vejdou. Příliš dlouhé na samostatném řádku je třeba zkrátit, nebo rozdělit na více řádků.
Některé komentáře jsou zcela zbytečné, nebo neužitečné. Nejhorší jsou takové, jež neodpovídají skutečnosti. Takové je třeba buď nahradit lepšími, nebo zcela odstranit. To může proběhnout zvlášť – nejdřív vyřešit pouze formátování a potom až obsah.
Příklady již neaktuálních komentářů:
Úkoly či jiné věci k vyřešení bývá dobré označit klíčovým slovem. Buď
TODO
, neboFIXME
, případně se zavináčem (@TODO
). To umožňuje je snadno všechny najít a vývojová prostředí s nimi často umí pracovat.