ブロックコメントで、80文字を超えるURLを参照したいと思います。
このURLを表示するための推奨される規則は何ですか?
bit.lyがオプションであることは知っていますが、URL自体は説明的です。それを短縮してから、短縮されたURLを説明するネストされたコメントを付けることは、くだらない解決策のように思えます。
回答:
URLを壊さないでください:
# A Foolish Consistency is the Hobgoblin of Little Minds [1]
# [1]: http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
PEP8から
しかし、最も重要なことは、いつ矛盾するかを知ることです。スタイルガイドが適用されない場合があります。疑わしい場合は、最善の判断を下してください。他の例を見て、何が最もよく見えるかを決定します。そして、遠慮なく質問してください!
特定のルールを破る2つの理由:
- ルールを適用すると、ルールに従ったコードを読むことに慣れている人でも、コードが読みにくくなります。
個人的に、私はそのアドバイスを使用し、むしろ人々のためにあなたのコメントに完全な説明的なURLを残します。
# noqa
行の終わりにあるを使用して、PEP8 / Flake8がそのチェックを実行しないようにすることができます。これは、PEP8によって次の方法で許可されます。
特別な場合は、規則を破るほど特別なものではありません。
あなたはグーグルのようなURL短縮サービスを使用しているので、これから:
http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
あなたが得る:
私のオプションは次のとおりです。
URL = ('http://stackoverflow.com/questions/10739843/'
'how-should-i-format-a-long-url-in-a-python-'
'comment-and-still-be-pep8-compliant')