graphql / graphql/graphql.github.io

Schema Design: Use triple quotes for descriptions

Aperta
#2,355 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
889
Fork
1.5k
Merge medio
4g 12h
PR unite (30g)
21

Descrizione

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
```

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.