毋庸置疑的,相同的編碼風格有助於開發人員相互合作。如果你想幫助我們改進代碼,我們建議你花幾分鐘時間來了解一下所使用的編碼風格。
我們使用 eslint 來檢查 TypeScript 和 JavaScript 編碼樣式。
1npm run eslint
我們通過 stylelint 檢查 SCSS 編碼樣式。
1npm run stylelint
因爲 Hugo 參數名大小寫不敏感,推薦使用 snake_case 命名方式。
Parameter | |
---|---|
FooBar | ❌ |
fooBar | ❌ |
foobar | ❌ |
foo-bar | ❌ |
foo_bar | ✅ |
於某些文件系統,文件名大小寫敏感,因此我們推薦總是使用 kebab-case
命名。
Filename | |
---|---|
fooBar.html | ❌ |
foo-bar.html | ✅ |
PascalCase
命名方式,如 Go 語言一樣。camelCase
命名方式。我們建議儘量使用 Bootstrap CSS 工具類,以減少 CSS 包的大小。