graphql / graphql/graphql.github.io
Schema Design: Use triple quotes for descriptions
Abierto
- Lenguaje dominante
- TypeScript
- Estrellas
- 889
- Forks
- 1.5k
- Merge medio
- 4 d 12 h
- PR fusionados (30 d)
- 21
Descripción
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
```
Guía de contribución
Evaluación
Este issue todavía no se ha evaluado.