初めてのGraphQL Webサービスを作って学ぶ新世代APIによると、スキーマ定義ファイルにて各スキーマにコメントをする場合は、以下のようにダブルクォーテーション3つで囲むということになっています。
scheme.graphqls
"""本"""
type Book {
"""ID"""
id: ID
"""名前"""
name: String
"""ページ数"""
pageCount: Int
"""著者"""
author: Author
}
上記のように書くことで、GraphiQLやGraphQL PlaygroundのDescriptionにもダブルクォーテーション3つで囲ったコメントが表示されるようになるとのことでした。
ただ、当方Java + Spring BootでGraphQLを軽く書いている中で、上記の書きっぷりだとGraphiQLやGraphQL Playgroundへは反映されず、No Descriptionとなってしまうことに気付きました。
そのため、以下のように先頭に#を置く書くことで解決しました。
scheme.graphqls
# 本
type Book {
# ID
id: ID
# 名前
name: String
# ページ数
pageCount: Int
# 著者
author: Author
}
GraphiQLとGraphQL Playgroundで確認すると以下の通り表示されるようになりました。
以上です。