【Pyhton】给函数写功能注释，说明param和return参数，经验分享

  最近写python，给函数写注释说明param和return的时候，在Pycharm的“鼠标悬停、显示函数说明”的功能下，怎么看都不满意，如下图：

  我想对return的值进行说明，但是return的变量名sent_length和max_length与说明的句子混在一起，不容易区分，普通的换行\n用不了。经过我的一番探索，终于发现这个三引号内特定的return注释写法有点像markdown，但绝对不是，因为markdown90%以上的语法（包括换行的语法）都用不了，能用的只有：

**text**
# 双星号加粗
*text*
# 单星号斜体

  使用后效果如下：

  这个效果应该能让不熟悉我代码的（包括很久后忘记的我）容易看出return的变量是什么以及对它们的说明。
  如果有更好看的写法，欢迎各位大佬留下评论！

             创作不易，如果有所帮助，求点赞收藏，谢谢！