kstack-gdscript

Godot 4 の GDScript と GdUnit4 テストの規約。理由を理解した上で適用すること。

宣言すべてに日本語の ## doc comment を書く

class・signal・const・公開 var・関数（private の _ 始まりを含む）の直前に ## で書く。関数には引数・戻り値・null を返す条件・emit する signal を含める。

# Bad: 名前だけでは量の単位も副作用も分からない
const GAIN_PER_CLICK: int = 1
func click() -> int:

# Good: 意味と契約を doc に書く
## 1 回のクリックで増えるスコア。
const GAIN_PER_CLICK: int = 1