ページへ戻る

− Links

 印刷 

Python​/コメント のバックアップの現在との差分(No.2) :: NJF Wiki

xpwiki:Python/コメント のバックアップの現在との差分(No.2)

« Prev[4]  Next »[5]
2: 2016-12-28 (水) 07:11:19 njf[6] ソース[7] バックアップ No.2 を復元して編集[8] 現: 2017-01-02 (月) 15:06:33 njf[6] ソース[9] 編集[10]
Line 19: Line 19:
 #これはコメント  #これはコメント
 + 
 print u"コメントのテスト"  print u"コメントのテスト"
Line 36: Line 36:
 コメントのテスト  コメントのテスト
-一行のコメントならなるべくこちらを使うのがおすすめです。+一行のコメントならなるべくこちらを使うのがおすすめです。また、複数行でも制御構造の中でインデントが複雑になっている場所ならこちらのコメントの方があつかいやすいです。
*文字列を使った複数行のコメント [#n4ea209e] *文字列を使った複数行のコメント [#n4ea209e]
Line 52: Line 52:
 hd = """複数行の文字列が  hd = """複数行の文字列が
 書けます。"""  書けます。"""
 + 
 print hd  print hd
Line 99: Line 99:
このように複数行のコメントは便利ですが、インデントを気にしないといけないことや、普通の処理としてヒアドキュメントを使っていると、そちらと混じるとわかりづらいという欠点もあります。 このように複数行のコメントは便利ですが、インデントを気にしないといけないことや、普通の処理としてヒアドキュメントを使っていると、そちらと混じるとわかりづらいという欠点もあります。
-また、「#」によるコメントは最近の統合環境などでは、たいてい複数行を一括で自動でしてくれる機能もあるので、処理を一時的に消すにはそちらの方が便利なこともあります。+また、「#」によるコメントは最近の統合環境などでは、たいてい複数行を一括で自動でコメントアウトしたり、元に戻したりしてくれる機能もあるので、処理を一時的に消すにはそちらの方が便利なこともあります。
そのせいか、ヒアドキュメントを複数行のコメントとして使うのは、ファイルの先頭や関数、クラスなどの定義のところなど、制御構造と関わりの無い場所で使われることが多いです。 そのせいか、ヒアドキュメントを複数行のコメントとして使うのは、ファイルの先頭や関数、クラスなどの定義のところなど、制御構造と関わりの無い場所で使われることが多いです。
-単にもともと複数行のコメントを必要とするのがそういう場所と言うだけかも知れませんが。+ 
 +特に関数やクラスの先頭で使われるものを「ドキュメントストリング」と呼び、「__doc__ 」で参照することが可能です。ドキュメントストリングについては「[[Python​/関数定義:http://njf.jp/cms/modules/xpwiki/?Python%2F%E9%96%A2%E6%95%B0%E5%AE%9A%E7%BE%A9#t8b3f869]]」を参照してください。
« Prev[4]  Next »[5]