首页 > 解决方案 > APIDOCJS - 在描述中添加换行符

问题描述

我想在描述中添加一个换行符。但我找不到合适的语法。

我想要实现的是所有这 3 个 @apiError 将组合在同一个组件下。

@apiError [(group)] [{type}] field [description]

@apiError {String} 400 1 or more parameters is empty. 
@apiError {String} 400 Your account is suspended.
@apiError {String} 400 Your account not found.

参考:http ://apidocjs.com/#param-api-error

也许像这样的技巧可以,但我还没有测试它。

@apiError {String} 400 1 or more parameters is empty. <br> Your account is suspended. <br> Your account not found.

谢谢。

标签: api-doc

解决方案


更新..这种语法有效。

@apiError {String} 400 1 or more parameters is empty <br> Your account is suspended <br> Your account not found.

推荐阅读