W komentarzu blokowym chcę odwołać się do adresu URL, który ma ponad 80 znaków.
Jaka jest preferowana konwencja wyświetlania tego adresu URL?
Wiem, że bit.ly jest opcją, ale sam adres URL jest opisowy. Skrócenie go, a następnie zagnieżdżony komentarz opisujący skrócony adres URL wydaje się kiepskim rozwiązaniem.
Odpowiedzi:
Nie niszcz adresu 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
Z PEP8
Ale co najważniejsze: wiedz, kiedy być niekonsekwentnym - czasami przewodnik po stylu po prostu nie ma zastosowania. W razie wątpliwości kieruj się najlepszą oceną. Spójrz na inne przykłady i zdecyduj, co wygląda najlepiej. I nie wahaj się zapytać!
Dwa dobre powody, aby złamać określoną zasadę:
- Zastosowanie reguły sprawi, że kod będzie mniej czytelny, nawet dla kogoś, kto jest przyzwyczajony do czytania kodu zgodnego z regułami.
Osobiście skorzystałbym z tej rady i raczej zostawiłbym w komentarzu pełny opisowy adres URL dla ludzi.
Możesz użyć # noqana końcu linii, aby powstrzymać PEP8 / Flake8 przed uruchomieniem tego testu. Jest to dozwolone przez PEP8 poprzez:
Specjalne przypadki nie są na tyle wyjątkowe, aby łamać zasady.
Powiedziałbym zostaw to ...
PEP20 :
Specjalne przypadki nie są na tyle wyjątkowe, aby łamać zasady.
Chociaż praktyczność przewyższa czystość.
Bardziej praktyczna jest możliwość szybkiego kopiowania / wklejania adresu URL, a następnie usuwania podziałów wierszy podczas wklejania do przeglądarki.
Używasz skracacza adresów URL, takiego jak Google, więc z tego:
http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
dostajesz:
Moją opcją byłoby:
URL = ('http://stackoverflow.com/questions/10739843/'
'how-should-i-format-a-long-url-in-a-python-'
'comment-and-still-be-pep8-compliant')