[ダークホース]ネットコースノートノート

注記

目標

• 役割のコメント
• 単一行コメント（コメント行）
• 複数行コメント（コメントブロック）

01.ノートの役割

読みやすさを向上させるためのプログラムで、自分の使い慣れた言語でいくつかのコードのラベルの指示を使用します

02.単一行コメント（コメント行）

• するには#で始まる、#すべての正しいことをとして説明のテキストではなく、実行される実際のプログラムされている、唯一の補助的な役割の説明を演じます

• 次のようにサンプル・コードは次のとおりです。

# 这是第一个单行注释
print("hello python")

コードの可読性を確保するために、#次に適切なキャプションを書き、スペースを追加するために戻ってお勧めします

単一行コメントコードの増加の背後に

• プログラム開発では、また、使用することができる場合#、例示（次の）単語の後ろにコードを高めるために

• しかし、注目すべきは、そのコードの可読性を確保するために、コメントとコードの間に少なくとも持っている必要があります二つのスペースを

• 次のようにサンプル・コードは次のとおりです。

print("hello python")  # 输出 `hello python`

03.複数行コメント（コメントブロック）

• あなたが書きたい場合はコメントに多くの情報を、行を表示することができない、あなたは複数行のコメントを使用することができます

• することができPythonの複数行コメントでプログラムを使用するには、三つの連続マークの1組（単一引用符と二重引用符であってもよいです）

• 次のようにサンプル・コードは次のとおりです。

"""
这是一个多行注释

在多行注释之间，可以写很多很多的内容……
""" 
print("hello python")

とき私は、コメントを使用する必要がありますか？

1. コメントはありません優れているコードの一見のために、あなたがコメントを追加する必要はありません、
2. 以下のために複雑な操作操作が始まる前に、コメントのいくつかの行に記述する必要があります
3. 以下のための明確でないコードテール行のコメントに追加しなければならない、（読みやすさを向上させるために、コードのコメントは、少なくとも2つのスペースを残すべきです）
4. コードの記述、コードがあなたのPythonよりもよく知っている読者は、彼は自分のコードが何をすべきかわからないことを前提としていません

いくつかの正式な開発チームでは、通常はそこにあるコードレビューの習慣が、お互いにお互いのコードを読んでチームです

コードの規格について

• Python 公式にはPEP（Pythonの強化提案）一連の文書を提供しました
• 以下のために設計された8つの文書の最初のPythonコードの形式は、一般的として知られていますアドバイス、PEP 8
• ドキュメント住所：https://www.python.org/dev/peps/pep-0008/
• Googleは、対応する中国の文書があります。http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

任意の言語のプログラマはコードの対応は、キャリアのプログラムを起動する最初のステップです書きます