🎄teratailクリスマスプレゼントキャンペーン2024🎄』開催中!

\teratail特別グッズやAmazonギフトカード最大2,000円分が当たる!/

詳細はこちら
ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

プログラミング言語

プログラミング言語はパソコン上で実行することができるソースコードを記述する為に扱う言語の総称です。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

Q&A

3回答

4833閲覧

Pythonドキュメンテーション文字列のReturnsとparamの意味について

退会済みユーザー

退会済みユーザー

総合スコア0

ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

プログラミング言語

プログラミング言語はパソコン上で実行することができるソースコードを記述する為に扱う言語の総称です。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

0グッド

0クリップ

投稿2019/12/30 12:22

プログラミング初心者でpythonを独学で学んでいるものです。
参考書に以下のように書かれていました。

def add(x, y):
"""
Returns x + y.
:param x: int.
:param y: int.
:return: int sum of x and y.
"""
return x + y

この中で"""に挟まれた部分がドキュメンテーション文字列で、:return: int sum of x and y.は戻り値について説明していることは分かりますが、paramがどのような意味なのか知りたいです。また、Returnsと複数形になっているのは、なぜなのか知りたいです。

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答3

0

以下のような、pythonを作り実行してみました。

python

1# -*- coding: utf-8 -*- 2def add(x, y): 3 """ 4Returns x + y. 5:パラメーター x: int. 6:パラメーター y: int. 7:戻り値: int sum of x and y. 8""" 9 return x + y 10print(add.__doc__)

結果は

Returns x + y. パラメーター x: int. パラメーター y: int. 戻り値: int sum of x and y.

と出力されました。
関数中に書いた"""~"""('''~'''もか-未検証-)はdocstringと解釈され、printしたり、IDEで表示できるようになるみたいですね。
詳細は、pythonのドキュメントを調べるのが良いのではないでしょうか。
いつかはpythonのドキュメントをじっくり読んでみたいのですが時間がないのでなかなかできません。
こんなサイト[Python]可読性を上げるための、docstringの書き方を学ぶ(NumPyスタイル)
がありましたので勉強してみたいかがでしょうか。
『paramがどのような意味なのか』はパラメーターを説明したいのでしょうね(慣習かチームの統一性を図っているのでは)。
『Returnsと複数形になっている』のは、記述したプログラマーの頭を覗かないとわかりませんね。

投稿2019/12/30 13:09

ikapy

総合スコア1167

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

param(parameter)は日本語で言うところの「引数」ですね。(上記の場合、xとyのこと)

投稿2019/12/30 12:34

meg_

総合スコア10736

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

param → parameter (仮)引数

Returns は、この関数は返り値が1つですが、複数の値を返す関数もあるので、こういう書式にしているんでしょう。

投稿2019/12/30 12:41

otn

総合スコア85882

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだベストアンサーが選ばれていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.36%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問