Python 广泛使用的文档标准是 Sphinx MarkUp， 主要原因是可以部署在 read the docs 网站上。 VSCode 有相应的插件。
https://stackoverflow.com/questions/9195455/how-to-document-a-method-with-parameters