GraphQL 游乐场类型详细多行注释？

Question

我正在尝试使用 GraphQL 记录我的 API。对于可读性问题，我想在多行中留下评论，但它似乎不适用于常规的 '\n' 换行符

"""
  Return:\n true : DB save successful\n false : DB save unsuccessful
"""

这是我试过的

但是它的输出完全一样，没有在新行中添加行

Return:\n true : DB save successful\n false : DB save unsuccessful

是否可以像这样在换行中排列文本：

Return:
 true : DB save successful
 false : DB save unsuccessful

Answer 1

块字符串在设计上不允许转义字符，但您可以在字符串中使用新行：

"""
Return:
true : DB save successful
false : DB save unsuccessful
"""

或者您可以使用允许转义字符的常规字符串：

"Return:\n true : DB save successful\n false : DB save unsuccessful"

编辑：

GraphQL 游乐场使用 this component under the hood to render the descriptions, which itself treats the description as markdown and renders it using markdown-it。 Markdown 忽略单个换行符，所以你必须使用两个：

"""
Return:

true : DB save successful

false : DB save unsuccessful
"""

GraphQL 游乐场类型详细多行注释？

GraphQL playground type detail multiline comment?

graphql

graphql-playground