長久以來一直都習慣在 Ubuntu 下使用 flake8 這個工具來檢查自己 python source code 有沒有符合 pep8 規範。
在 Ubuntu 下安裝 flake8
使用
這個工具同時也可以和 vim 共用，使得使用者在用 vim 的時候可以即時看到檢查結果。（但我今天沒打算聊這個 XD）
但今天被強者我同事糾正我的 docstring 沒有符合規範，建議我可以使用 flake8-docstrings 這個工具將檢查更完善一些。我才注意到 1. Ubuntu 下沒有這個 package 2. 以往我都漏掉這個檢查了。於是趕緊補上：
因為 Ubuntu 沒有納入管理 flake8-docstring 這個套件，所以我改用 pip 安裝工具來安裝：
安裝之後再使用 flake8 就可以看到它會去掃出不符合規範的 docstring 了，例如：
在 Ubuntu 下安裝 flake8
sudo apt-get install python-flake8
使用
flake8 <your source code>
這個工具同時也可以和 vim 共用，使得使用者在用 vim 的時候可以即時看到檢查結果。（但我今天沒打算聊這個 XD）
但今天被強者我同事糾正我的 docstring 沒有符合規範，建議我可以使用 flake8-docstrings 這個工具將檢查更完善一些。我才注意到 1. Ubuntu 下沒有這個 package 2. 以往我都漏掉這個檢查了。於是趕緊補上：
因為 Ubuntu 沒有納入管理 flake8-docstring 這個套件，所以我改用 pip 安裝工具來安裝：
sudo pip install flake8_docstrings
安裝之後再使用 flake8 就可以看到它會去掃出不符合規範的 docstring 了，例如：
$ flake8 <my source code>
......
D300 Use """triple double quotes"""
D400 First line should end with a period
D102 Missing docstring in public method
......
環境：Ubuntu Trusty
沒有留言:
張貼留言