複数行のコメントの書き方は既にわかっているので、3 つの単一引用符または 3 つの二重引用符を使用できます。必要なときにドキュメントを取得できるように、関数を説明するときにドキュメント文字列を使用します。名前にカーソルを合わせるだけでドキュメントを表示する IDE もあれば、特定のキーワードを強調表示する IDE もあります。しかし実際のところ、NumPy の docstring は他の言語よりもはるかに柔軟です。 Docstring は、関数定義の先頭にある文字列リテラルです。関数、クラスなどの場合、docstring を使用する際に特定の値を提供する必要があります。
関数でdocstringを使用する場合、引数を渡す必要があります。クラスでそれらを使用する場合、属性とメソッドを渡します。モジュールの場合、クラスと関数のリストを提供する必要があります。パッケージの場合、機能を持つモジュールのリストを渡します。基本的に、docstring の目的は、その名前が示すように、コードのドキュメント化に役立つことです。誰かが将来私たちのコードを使用する場合、docstring の助けを借りて私たちのコードとコードの背後にあるロジックを理解できるように、ドキュメントを作成します。組み込み関数にも docstring があります。 help() の関数を使用して、組み込み関数の docstring を確認できます。
コメントとドキュメントストリングにはいくつかの違いがあります。コメントはインタープリターによって無視されますが、docstring はインタープリターによって無視されません。メモリはドキュメント文字列に割り当てられます。コメントはコードの説明ですが、一方、docstring はコードの目的を教えてくれます。
構文：
NumPy で docstring を記述する構文は次のとおりです。
'''Docstring メッセージ'''
または
'''Docstring メッセージ'''
docstring は関数やメソッドではないため、適切な構文がないことに注意してください。ここで注意すべき唯一のことは、3 つの単一引用符または 3 つの二重引用符で docstring を開始することです。コードの説明を書き、最後に 3 つの一重引用符または 3 つの二重引用符で再び終了します。 docstring について書く義務はありません。文字列の説明の前後に 3 つの一重引用符または二重引用符を配置するだけです。
例 1:
docstring をよりよく理解するために、例を実行してみましょう。この例では、NumPy ライブラリをインクルードした後、変数「a」と別の変数「b」を宣言するだけです。その後、「「a」変数と「b」変数を追加しましょう」という docstring を作成します。私たちの場合、これは簡単な例ですが、コードが複雑な場合、コーダーがコードを理解するのに大いに役立ちます。その後、変数「a」と「b」を合計し、その出力結果を別の変数「c」に格納します。最後に、変数「c」の値を出力します。次に、コードを実行します。
輸入 でこぼこ なので 例えばa = 1
b = 2
'''a 変数と b 変数を追加しましょう'''
c = a+b
印刷する ( c )
これは、指定されたコードからの出力です。システムは、不正な構文に関するエラーや、コードの 7 行目に関するエラーを表示していないことがわかります。また、システムは docstring を出力していません。代わりに、システムに出力するように指示した変数「c」の出力のみを出力しました。これは、docstring がどのように機能するかを示しています。次回、新しいコーダーが私たちのコードに取り組もうとするとき、彼はドキュメントストリングの助けを借りて私たちが何をしているのかを理解するでしょう。ただし、出力として出力されないため、コードのユーザーが邪魔されることはありません。
例 2:
ここで、docstring の動作を理解するために複雑な例を実行します。まず、NumPy ライブラリをインクルードしてから、配列の初期化を説明するコードの次の行を説明するドキュメント文字列を記述します。また、コードの他の部分に docstring を追加します。さて、docstring を追加せずにこのコードを新しい Python 開発者と共有すると、彼がこのコードの動作と目的を知るのはどういうわけか難しくなります。彼はまず、私たちが使用した関数について検索する必要があります。しかし、コードに docstring を追加すると、他の開発者が関数について詳しく調べなくても簡単にコードを理解できるようになります。いくつかの制限にコメントを追加することに制限されていません。コメントは、1 行または複数行にすることができます。コードに複数回追加することもできます。次に、NumPy を np としてインポートします。
'''サイズ 1x6 の配列を渡す変数を作成しています'''配列 = 例えば 配列 ( [ 十一 、 22 、 33 、 44 、 55 、 66 ] )
'''配列を tofile() 関数に割り当てて、arr という名前のファイルに保存させます'''
配列 . ファイルへ ( 「arr.bin」 )
'''fromfile関数を使用してファイルを表示'''
印刷する ( 例えば ファイルから ( 「arr.bin」 、 dtype = 整数 ) )
次のスニペットに示すように、docstring は出力に表示されません。つまり、コードの出力やコンパイルには影響しません。 Docstrings は、コンパイル プロセス中に無視されます。
結論
このガイドでは、NumPy の docstring について学びました。 docstring とコメントを比較し、両者の違いを説明しました。 docstring の構文と、コードに docstring を記述する方法を学びました。さらに、NumPy の docstring とは何か、例を使用してどのように機能するかについても説明しようとしました。最後に、それらはコーダーにとって不可欠であると述べました。 NumPy における docstring の重要性については繰り返しません。コード内で docstring を使用する必要があることだけをお伝えします。 NumPy では、docstring の書き方が最も一般的です。プログラミング コミュニティでは、コードの動作と機能についてお互いに知らせるために広く使用されています。このガイドは、NumPy docstring を使い始めるのに役立ちます。 NumPy の docstring を使用して必要なもののほとんどをカバーしようとしました。