Code Style - ntut-xuan/FastShop Wiki

我們的程式碼必須有基本的可讀性,好的編排方式能突現出應注意的地方。

Python

Formatter

使用 Black

它的好處是不接受客製化設定,你可以很快速地融入使用 Black 的專案中,因為他們的風格都是一致的。

$ black {source_file_or_directory}

Type Check

使用 Mypy

Python 是弱型別語言,很多時候我們不能輕易確定函式的回傳值型態,而不夠細膩的命名方式將使這個問題更加嚴重。在 PEP 484 – Type Hints 引入型態標註之後,我們開始有更好的方法來解決這個問題。

絕大多數的情況下使用 type hints 並不會影響我們寫出流暢的程式碼。

$ mypy {source_file_or_directory}

JavaScript

Formatter

使用 Airbnb JavaScript Style,目前應該算是主流的 coding style。

Checker

使用 JSCS 來確認所有的 .jsx 能夠遵循 Airbnb JavaScript Style