Question

我正在使用Natural Docs从我的python代码生成文档，我的python评论是这样的：

Function: get_students



Parameters:
since_data: 

Returns:
res: 

{'count': 

'info': [
'mobile': '15011111111',
'nickname': 'xiaoya',
'gender': 0(unknow) or 1(male) or 2(female),
'level': 0-12,
'register_at': '2013-01-01 08:08:08',
]
}

"""

我的config.txt是这样的：

Language: Python

Extension: py
Shebang String: python
Line Comment: #
Block Comment: """ """
Function Prototype Ender: :
Variable Prototype Ender: =
Line Extender: /

当我得到生成的html时，返回值没有换行符，我只能得到这样的换行符：

Returns:
res: 

{'count': \n

'info': [

'mobile': '15011111111',

'nickname': 'xiaoya',

'gender': 0(unknow) or 1(male) or 2(female),
'level': 0-12,
'register_at': '2013-01-01 08:08:08',
]
}

我必须在每一行之间添加一个空白行以获得换行符，有人可以帮我这个吗？

Answer 1

源中的换行符不会转换为输出中的换行符，以允许您在多行上写入单个段落的文本;无需滚动或使用文本编辑器的自动换行功能。 Web浏览器也以这种方式呈现HTML中的文本段落。

您的文档中似乎需要预先格式化的部分，并在编写时使用换行符。我在退货部分中封装了您的示例的行(start code)和(end)将会处理它：

Returns:
res: 

(start code)
{'count': 

'info': [
'mobile': '15011111111',
'nickname': 'xiaoya',
'gender': 0(unknow) or 1(male) or 2(female),
'level': 0-12,
'register_at': '2013-01-01 08:08:08',
]
}
(end)

或者，您可以通过>为示例的每一行添加前缀，但这样做会更有效。有关详细信息，请查看Natural Docs comment formatting中的代码和文字图部分。

自然文档评论不能有换行符

1 个答案: