Python 自然文档评论可以';不要断线

Python 自然文档评论可以';不要断线,python,comments,markdown,doc,Python,Comments,Markdown,Doc,我使用自然文档从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': '2

我使用自然文档从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',
]
}

"""
Language: Python

Extension: py
Shebang String: python
Line Comment: #
Block Comment: """ """
Function Prototype Ender: :
Variable Prototype Ender: =
Line Extender: /
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',
]
}
我的config.txt如下所示:

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',
]
}

"""
Language: Python

Extension: py
Shebang String: python
Line Comment: #
Block Comment: """ """
Function Prototype Ender: :
Variable Prototype Ender: =
Line Extender: /
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',
]
}
当我得到生成的html时,返回值没有换行符,我只能得到如下换行符:

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',
]
}

"""
Language: Python

Extension: py
Shebang String: python
Line Comment: #
Block Comment: """ """
Function Prototype Ender: :
Variable Prototype Ender: =
Line Extender: /
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',
]
}

我必须在每一行之间添加一个空行以获得换行符。如何解决此问题?

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

您似乎希望在文档中有一个预格式化的部分,在编写时带有换行符。我将您的示例封装在返回部分中的
(开始代码)
(结束)
行将处理它:

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)
或者,您可以在示例的每一行前面加上前缀
,但这需要更多的工作。有关更多信息,请参阅中的章节代码和文本图