回答編集履歴
2
追記
answer
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
解決
|
|
1
|
+
解決策ではありませんし、ご存知の上での質問かもしれませんが、1つの回答として書きます。
|
|
2
2
|
開発チームの取り決めでスタイルが制限されていてこの問題が発生してしまうというような場合はあてはまらないのですみません。
|
|
3
3
|
|
|
4
4
|
pythonプロジェクトは、[書き方の作法として pep8](https://pep8-ja.readthedocs.io/ja/latest/) というのを提供/公開しています。
|
|
5
5
|
コーディングのスタイルについてのいろいろな規定ですが、これを守ることで、見た目の統一が取れ、他の人に読んでもらってり、他人のコードを読むときにもあまり違和感を感じることが少なくなり、メンテナンスなどしやすくなります。
|
|
6
|
+
そして、お使いの整形ツールもこの規定に沿った修正を行なうようになっています。
|
|
6
7
|
|
|
7
8
|
それに従う場合、「[関数定義の前は2行空ける](https://pep8-ja.readthedocs.io/ja/latest/#id12)」ことになります。また、そうすると質問にあるコメントが離れてしまいますが、このような関数の内容についてのコメントは「[このコメントは def の行のあとに置くべきです](https://pep8-ja.readthedocs.io/ja/latest/#id23)」というように、defの後に書くことで離れてしまうことを防ぐことができます。
|
|
8
9
|
|
1
リンク忘れ
answer
CHANGED
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
pythonプロジェクトは、[書き方の作法として pep8](https://pep8-ja.readthedocs.io/ja/latest/) というのを提供/公開しています。
|
|
5
5
|
コーディングのスタイルについてのいろいろな規定ですが、これを守ることで、見た目の統一が取れ、他の人に読んでもらってり、他人のコードを読むときにもあまり違和感を感じることが少なくなり、メンテナンスなどしやすくなります。
|
|
6
6
|
|
|
7
|
-
それに従う場合、「[関数定義の前は2行空ける](https://pep8-ja.readthedocs.io/ja/latest/#id12)」ことになります。また、そうすると質問にあるコメントが離れてしまいますが、このような関数の内容についてのコメントは「このコメントは def の行のあとに置くべきです」というように、defの後に書くことで離れてしまうことを防ぐことができます。
|
|
7
|
+
それに従う場合、「[関数定義の前は2行空ける](https://pep8-ja.readthedocs.io/ja/latest/#id12)」ことになります。また、そうすると質問にあるコメントが離れてしまいますが、このような関数の内容についてのコメントは「[このコメントは def の行のあとに置くべきです](https://pep8-ja.readthedocs.io/ja/latest/#id23)」というように、defの後に書くことで離れてしまうことを防ぐことができます。
|
|
8
8
|
|
|
9
9
|
pep8に沿ってコードを書くのは最初は慣れないので違和感がありますが、慣れてしまえば書きやすくなりますし、他人のコードが読み易くなります。
|