ノートパイソン(Pythonのコメント)の詳細な使用方法

@

コメント1 Pythonの概要

注(コメント)アイデアやヒント、開発者(ユーザ)コードのどこにでも添加することができるいくつかの他のコードの役割と機能を説明するために使用されます。Pythonインタプリタプログラム(コード)の実装に(Pythonのインタープリター)は、任意の処理、すなわち、コメントセクションが実行されないPythonのインタープリターなしで、コメントセクションを無視します。

通常、ソースコードの約1/3を占め、コード内のコメントの適切な量が非常に重要であるメモを追加。

シングルラインとマルチラインのコメント:Pythonはコメントの2種類をサポートしています。

役割2件のPythonのコメント

2.1デバッグコード

デバッグ(DEBUG)処理プログラム、一行のコメントはすぐにデバッグプログラムの効率を改善するために、誤差範囲を減らすために、いくつかの一時的コードに注釈を付けることができます。

次の手順を実行するには、次の
コードエラーの不確実どのような具体的なラインのケースでは、その潜在的に問題のあるコードがアップし、コメントを挿入し、その後、プログラムの観察を実行することができます。プログラムが正常に実行することができれば、それはエラーがこのコードによって引き起こされることを示し、同じエラーが依然として発生した場合逆に、それはエラーがこのコードによって引き起こされなかったことを示しています。

2.2プログラムの可読性を向上させます

ノートの最大の役割は、読みやすさを向上させることです、何の注釈プログラムは、聖書が過大ではないことを言って、理解することは困難ではありません。
さらに、時間をかけて、独自のコードを記述し、自分のアイデアや目的を忘れてしまいます。

3 Pythonの単一行コメント

3.1 Pythonの単一行コメントの概要

Pythonは#を使用して#、次のようにその構文は、単一行コメントとして記号を:

# 添加的注释内容

構文の上記の説明:

  • #単一行コメント記号として。
  • ポンド記号から#行の終わりがコメントであるまで、すべてのコンテンツまで開始します。Pythonインタプリタの出会い#、それはその背後にある行全体無視#内容はコメント欄に属し後の行を。

3.2コードの単一の行は、単一の行メモメモであります

一行注注するためのコードの単一の行は、通常、コードの右側にコメントし、次のようにコードは、二つの空間の間に間隔を置いて配置されます。

print("码农阿杰")  # 输出笔者的微信公众号名称
print('https://www.cnblogs.com/manongajie/')  # 输出笔者的博客园博客地址
print('https://blog.csdn.net/manongajie/')  # 输出笔者的CSDN博客地址

3.3メモメモは、コードの単一の行を複数行

場合は、次のようにコード内のコードの単一行コメントコメント行は、ライン上で一般のコメント:

# 使用 print() 内置函数输出字符串
print("微信公众号:码农阿杰")
print("博客园博客地址 https://www.cnblogs.com/manongajie/")
print("CSDN 博客地址 https://blog.csdn.net/manongajie/")

# 使用 print() 内置函数输出数字
print(520)
print(521)
print(1314)

3.4単一行コメントの注意事項

3.4.1文字列の一部が存在しているように、単一のラインがシンボルのコメント

1行コメントのシンボルの場合は#時間が文字列の一部として表示される次のように、それは、単一行コメントとして表示することはできませんが、文字列(文字列)の一部として、次のようになります。

print('# 微信公众号:码农阿杰')
print("# 博客园博客地址 https://www.cnblogs.com/manongajie/""")
print("# CSDN 博客地址 https://blog.csdn.net/manongajie/")

結果:

# 微信公众号:码农阿杰
# 博客园博客地址 https://www.cnblogs.com/manongajie/
# CSDN 博客地址 https://blog.csdn.net/manongajie/

上記のコードに示します:

  • Pythonはポンド記号ではない#単一行コメントタグとして、それ文字列の一部として。

4 Pythonの複数行のコメント

4.1 Pythonの複数行コメントの概要

プログラムのコードの複数行のコメント使い捨てコメント行を指し、それは、1行のコードであってもよいです。

Pythonのは、三つの連続単一引用符がでサポートされている'''コメントの始まりと終わりとして使用された、または3つの連続した二重引用符は、"""コメントの始まりと終わり、コメント使い捨て単一の行またはコンテンツの複数の行として使用されました。

複数行コメントは、通常はPythonの関数、クラス、モジュールなどの追加機能、バージョン、および著作者やその他の記述情報に使用されています。

4.2ノート三つの連続単一引用符

三つの連続した単一引用符形式以下の注釈内容:

'''
使用三个连续的单引号分别作为注释的开头和结尾
可以一次性注释多行内容或单行内容
'''

4.3ノート3つの連続引用

"""
使用三个连续的双引号分别作为注释的开头和结尾
可以一次性注释多行内容或单行内容
"""

以上の4.4行コメントは、関数のドキュメントを提供することができます

月のPythonによるhelp()または組み込み関数の__doc__次のコードに示すよう属性は、関数の説明文を表示します。

# 查看 print() 内置函数的说明文档
print('--- 用 help()内置函数查看说明文档 ---')
help(print)
print('--- 用 __doc__ 属性查看说明文档 ---')
print(print.__doc__)

結果:

--- 用 help()内置函数查看说明文档 ---
Help on built-in function print in module builtins:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
    
    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.

--- 用 __doc__ 属性查看说明文档 ---
print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

Prints the values to a stream, or to sys.stdout by default.
Optional keyword arguments:
file:  a file-like object (stream); defaults to the current sys.stdout.
sep:   string inserted between values, default a space.
end:   string appended after the last value, default a newline.
flush: whether to forcibly flush the stream.

実際には、ドキュメント機能(同じシンボルを有する複数行のコメント)、自分自身を書き込むために、プログラマが必要本質的に、文字列であるが、図は、ドキュメントの異なる配置であるように、通常機能の内側に位置する文字列、ドキュメント機能すべてのコードの一番。

それはどのようにマニュアルセットの関数でありますか?次のとおりです。

# 定义一个比较数字大小的函数
def num_max(num1, num2):
    """
    比较两个数字的大小
    :param num1:形参1,数字1
    :param num2:形参2,数字2
    :return:大的数字,max_num = num1 if num1 > num2 else num2
    """
    max_num = num1 if num1 > num2 else num2
    return max_num


result = num_max(1, 2)
print(result)
print('--- 用 help() 内置函数查看 num_max() 的说明文档 ---')
help(num_max)
print('--- 用 __doc__ 属性查看 num_max() 的说明文档 ---')
print(num_max.__doc__)

結果:

2
--- 用 help() 内置函数查看 num_max() 的说明文档 ---
Help on function num_max in module __main__:

num_max(num1, num2)
    比较两个数字的大小
    :param num1:形参1,数字1
    :param num2:形参2,数字2
    :return:大的数字,max_num = num1 if num1 > num2 else num2

--- 用 __doc__ 属性查看 num_max() 的说明文档 ---

    比较两个数字的大小
    :param num1:形参1,数字1
    :param num2:形参2,数字2
    :return:大的数字,max_num = num1 if num1 > num2 else num2
    

以上の4.5行のコメントノート

4.5.1複数行コメントは、ネストされたサポートしていません。

Pythonは、ネストされた複数行のコメントをサポートしていない、と書かれたエラーは次のとおりです。

'''
外层注释
    '''
    内层注释
    '''
'''

4.5.2複数行コメント記号'''"""文字列タグ

マルチラインは、シンボルのコメント'''"""文字列タグで始まりと終わりがあります。

Pythonの行のコメントを複数のシンボルの文字列の一部として表示された場合、それらは複数行のコメントタグとして使用することはできませんが、以下のように、文字列の一部として見られるべきです。

str_info1 = '''微信公众号:码农阿杰'''
str_info2 = """博客园博客地址 https://www.cnblogs.com/manongajie/"""
str_info3 = "CSDN 博客地址 https://blog.csdn.net/manongajie/"

print(str_info1)
print(str_info2)
print(str_info3)

結果:

微信公众号:码农阿杰
博客园博客地址 https://www.cnblogs.com/manongajie/
CSDN 博客地址 https://blog.csdn.net/manongajie/

上記のコードに示します:

  • Pythonは複数行のコメントとして、ここで3重引用符ではありませんが、彼らは、開始と終了マーカー文字列として見られています。

5つのその他の記事のアドレス

5.1マイクロチャンネル公共番号:農業Adgerコード

5.2 CSDNブログ

6つの参考文献

6.1 Pythonの3.8.2のドキュメント

おすすめ

転載: www.cnblogs.com/manongajie/p/12656388.html