[Python] Docstrings




Docstrings (Document Strings) 指的是出現在模組、函式、類別、方法的第一行的說明文字。使用者可以很容易的從物件的 __doc__ 屬性取得 docstring,也可以使用 pydoc 模組中的 help 函式來取得 docstring。

範例:

PEP 257 裡面的建議是,為了一致性,請使用 (“”” docstrings “””) 來做註解;如果含有 (\),則使用 (r””” docstrings “””);如果含有 unicode ,則使用 (u””” 說明文字 “””)。

參考連結:




Be the first to comment

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.