graphql / graphql/graphql.github.io

Schema Design: Use triple quotes for descriptions

Ouverte
#2,355 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
TypeScript
Étoiles
889
Forks
1.5k
Merge moyen
4 j 12 h
PR mergées (30 j)
21

Description

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

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.