.. explain_code:

コード解説のルール
==================

.. explain_code-functions:

関数
----

「``<関数名>()`` 関数」とし、サフィックスをつけます。

.. code-block:: rst

   ``print()`` 関数を実行します。

クラス
------

「``クラス名`` クラス」とし、サフィックスをつけます。クラスの所属元のモジュール名は付与しません。

.. code-block:: rst

   ``DataFrame`` クラス

メソッド
--------

「``<メソッド名>()`` メソッド」とし、サフィックスをつけます。

.. code-block:: rst

   ``plot()`` メソッドを実行します。

メソッドの所属クラスを明記した方が説明上都合がよい・または分かりやすい場面ではクラス名を記述します。

.. code-block:: rst

   ``DataFrame.plot()`` メソッドを実行します。

メソッドの所属オブジェクトを明記した方が説明上都合がよい・または分かりやすい場面ではオブジェクト名を記述します。

.. code-block:: rst

   ``df.plot()`` メソッドを実行します。

位置引数
--------

「``第<位置>引数`` 」とします。

.. code-block:: rst

   ``print()`` の第1引数には値を渡します。

キーワード引数
--------------

「引数 ``<引数名>`` 」とします。

.. code-block:: rst

   ``print()`` の引数 ``end`` に文字列を渡すと、末尾の出力文字列を指定できます。

返り値、戻り値
--------------

「返り値」とします。

.. code-block:: rst

   ``sum()`` の戻り値はスカラ型またはSeries型になります。