医生狗。
docshund的Python项目详细描述
D o c s h u n d
生成简单的代码文档
NOTE: Docshund is in alpha and is not yet suitable for production workloads. Please exercise caution when using.
安装
pip3installdocshund
用法
docshund code.py > documentation.md
她做什么：
NOTE: Docshund is in alpha and is not yet suitable for production workloads. Please exercise caution when using.
从这里开始：
classFoo:""" This is a foo. Do not cross the foo streams! """def__init__(self):""" Create a new foo. """defcross_streams(self,other_foo:Foo=None):""" Cross the streams of this foo with another foo. If you do this, it will throw an error. Arguments: other_foo (Foo: None): The foo with which you'd like to cross streams Returns: None Raises: FooError: Raised if you cross the streams. """ifother_foo:raiseFooError("What did we JUST tell you?!")
此降价：
## *Class* `Foo`
This is a foo.
Do not cross the foo streams!
## *Function* `__init__(self)`
Create a new foo.
## *Function* `cross_streams(self, other_foo: Foo = None)`
Cross the streams of this foo with another foo.
If you do this, it will throw an error.
### Arguments
> - **other_foo** (`Foo`: `None`): The foo with which you'd like to cross streams
### Returns
None
### Raises
> - **FooError** (`None`: `None`): Raised if you cross the streams.
类Foo
这是一个foo。
不要横渡溪流！
函数__init__(self)
创建一个新的foo。
函数cross_streams(self, other_foo: Foo = None)
穿过这条河和另一条河。
如果你这样做，它会抛出一个错误。
参数
- other_foo (
Foo:None): The foo with which you'd like to cross streams
返回
None
升高
- FooError (
None:None): Raised if you cross the streams.
生成此存储库的文档
此存储库的参考文档是使用以下命令生成的：
docshund docshund/__init__.py > docs/Reference.md
你可能会说我们…吃我们自己的狗粮。
法律
根据Apache2.0授权。向opensource@fitmango.com提问。
Copyright 2019 FitMango.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this codebase except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
在?用制成
欢迎加入QQ群-->： 979659372
