我正在尝试清理我的python代码文档，并决定使用sphinx-doc因为它看起来不错。我喜欢使用如下标签引用其他类和方法::class:`mymodule.MyClass`Aboutmyclass.:meth:`mymodule.MyClass.myfunction`Andmycoolfunction我正在尝试弄清楚如何在函数中记录参数名称，这样如果我有这样的函数:defdo_this(parameter1,parameter2):"""Icandescribedo_this.:something?:`parameter1`Andthendescribetheparameter.""

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。关闭7年前。Improvethisquestion我正在通过对资源使用JAX-RS注释来使用CXF开发Web服务。这些注释指定参数名称、默认值以及有效的输入和输出mime类型。如果能够在我的代码上运行javadoc-esque工具以生成该接口(interface)的简洁文档集，那就太好了，但我似乎找不到任何东西。javadoc本身生成的文档需要太多的精简，我真的想要一些能够理解JAX-RS注释语义并生成对

python处理apiDoc转swagger需要转换的接口现在我需要转换的接口全是nodejs写的数据，而且均为post传输的json格式接口apiDoc格式apiDoc代码中的格式如下：/***@api{方法}路径标题*@apiGroupGroup*@apiDescription描述这个API的信息**@apiParam{String}userName用户名*@apiParamExample{json}request-example*{*"userName":"Eve"*}**@apiError{String}message错误信息*@apiErrorExample{json}error-e

python处理apiDoc转swagger需要转换的接口现在我需要转换的接口全是nodejs写的数据，而且均为post传输的json格式接口apiDoc格式apiDoc代码中的格式如下：/***@api{方法}路径标题*@apiGroupGroup*@apiDescription描述这个API的信息**@apiParam{String}userName用户名*@apiParamExample{json}request-example*{*"userName":"Eve"*}**@apiError{String}message错误信息*@apiErrorExample{json}error-e