graphql / graphql/graphql.github.io
Schema Design: Use triple quotes for descriptions
未关闭
- 主要语言
- TypeScript
- 星标
- 889
- 派生
- 1.5k
- 平均合并
- 4 天 12 小时
- 30 天内合并 PR
- 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 还没有评估数据。