graphql / graphql/graphql.github.io
Schema Design: Use triple quotes for descriptions
オープン
- 主要言語
- TypeScript
- スター
- 889
- フォーク
- 1.5k
- 平均マージ
- 4日 12時間
- マージ済み PR（30日）
- 21
説明
Use triple-quote syntax (`"""description"""`) for field and type documentation, not `#` symbols.
Rationale: Triple quotes are parsed as descriptions and appear in introspection and documentation tools. Hash comments are ignored by the parser and invisible to consumers.
**Example:**
Prefer:
```
"""
The business name
"""
name: String
```
Not:
```
# The business name
name: String
```
コントリビューションガイド
評価
この issue はまだ評価されていません。