106.07.05 pylint warning [missing-docstring] Missing module docstring

解決warning
使用pylint之後有一個warning找頗久的就來記錄個
程式中的註釋已經可以提供許多資訊,Python還有另一種方式,可以讓使用者直接在程式碼中撰寫程式的文件,主旨用於說明模組、型態或函數的用途,這是以建立獨立存在的字串來進行的,其被稱為docstring。
單引號或雙引號字串都可用為docstring,不過Python還提供了另一種字串,連續用三個單引號或是雙引號圍起來的三引號字串,這在印出時會保留字串內原始編排格式,因此若有多行撰寫的需求,會是一種方便的選擇。
 說明有點多@@,來源在此那裡還有更詳盡說明和寫法

所以說加註文件、函式說明是更好的習慣

不過如果你也很懶的話....OuO



參考資料:
電腦做什麼事 第五章 程式結構
python中的文档字符串(docString)
Python Docstrings
Example Google Style Python Docstrings
A Beginner’s Guide to Code Standards in Python - Pylint Tutorial
C0111

沒有留言:

張貼留言

^ Top