GraphQL游乐场类型细节多行注释?

时间:2019-08-29 07:08:31

标签: graphql graphql-playground

我正在尝试使用GraphQL记录我的API。对于可读性问题,我想在多行中保留注释,但似乎不能与常规的'\ n'换行符一起使用

MutableLiveDataWithInitialValue

这是我尝试过的

但是它输出的结果完全相同,而无需在新行中添加行

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

是否可以在新行中排列文本,例如:

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

1 个答案:

答案 0 :(得分:0)

阻止字符串不允许按设计转义字符,但您只能在字符串内部使用新行:

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

或者您可以使用常规字符串,该字符串允许转义字符:

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

编辑:

GraphQL Playground在引擎盖下使用this component来呈现描述,该描述本身将描述视为减价并使用markdown-it进行呈现。 Markdown忽略单个换行符,因此您必须使用两个换行符:

"""
Return:

true : DB save successful

false : DB save unsuccessful
"""