Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
学ぶ Docstring | Annotations
Mastering Python: Annotations, Errors and Environment

bookDocstring

メニューを表示するにはスワイプしてください

Now, let's create the function's docstring (documentation string).

Docstring in Python is a documentation string that is used to describe the purpose and behavior of a function, module, or class. It is a string that is placed at the beginning of the function or module or class, enclosed in triple quotes """...""" and can span multiple lines:

12345
def add(a: int, b: int) -> int: """This function receives two integer arguments and returns its sum.""" return a + b print(add(21, 5))
copy

Let's look at the PyCharm hint:

How this hint looks without docstring:

The docstring is a brief description of your function.

Note

Annotations and Docstrings are used in real development. Some simple actions can save a lot of time for other developers.

すべて明確でしたか?

どのように改善できますか?

フィードバックありがとうございます!

セクション 1.  4

AIに質問する

expand

AIに質問する

ChatGPT

何でも質問するか、提案された質問の1つを試してチャットを始めてください

セクション 1.  4
some-alt