Better comment for python

comment-sample.py

# -*- coding: utf-8 -*-

u"""Hoge これはコメントの書き方のサンプルです。

 ダブルクォート3つの中に書いたものがドキュメンテーション文字列として扱われます。

 ファイルの先頭にあるこの部分は DESCRIPTION というブロックになります。
 1行目は NAME というブロックになります。

 先頭に u をつけているのはユニコード文字列として扱われるようにするためです。

 日本語でコメントを書く場合は u つけたほうがいいでしょう。
 もし日本語のコメントが python シェルでうまく表示できない場合は
 次の設定が必要です。
 import sys, codecs
 sys.stdout = codecs.getwriter('utf8')(sys.stdout)
"""

# hugaする関数 このコメントは ドキュメンテーション文字列ではありません
def huga():
  u"""関数の場合は関数宣言のすぐ後に書きます。
  トリプルクォートのすぐ後が1行目です。
  """

class Poyo(object):
  u"""Poyo クラスの説明です。

  このドキュメントは doc(Poyo) または Poyo.__doc__ として参照されます。
  """

  def piyo(self, name):
    u"""" Poyo クラスのpiyoメソッドの説明です。 """
    pass

  def puyo(self):
    u"""コメントには *reStructuredText* テキスト形式を使うとより幸せになれるかもしれません。
    """
    pass

# vim: fenc=utf8 et sw=2 ts=2