風格指南

毋庸置疑的,相同的編碼風格有助於開發人員相互合作。如果你想幫助我們改進代碼,我們建議你花幾分鐘時間來了解一下所使用的編碼風格。

TypeScript 風格指南

我們使用 eslint 來檢查 TypeScript 和 JavaScript 編碼樣式。

1npm run eslint

SCSS 風格指南

我們通過 stylelint 檢查 SCSS 編碼樣式。

1npm run stylelint

Hugo 風格指南

命名約定

參數命名約定

因爲 Hugo 參數名大小寫不敏感,推薦使用 snake_case 命名方式。

Parameter
FooBar
fooBar
foobar
foo-bar
foo_bar

文件命名約定

於某些文件系統,文件名大小寫敏感,因此我們推薦總是使用 kebab-case 命名。

Filename
fooBar.html
foo-bar.html

變量命名約定

  1. 對於可導出的變量,使用 PascalCase 命名方式,如 Go 語言一樣。
  2. 對於局部變量,使用 camelCase 命名方式。

Bootstrap 風格指南

我們建議儘量使用 Bootstrap CSS 工具類,以減少 CSS 包的大小。

razonyang
2024年6月15日 星期六 2022年12月14日 星期三