mkdocstrings-vba

为mkdocstrings提供的VBA处理器。

由于没有官方方式记录VBA函数，我们选择了在Python项目中常用的Google Docstring格式。该格式方便由griffe库解析，该库也用于mkdocstrings[python]。参数类型和返回类型来自VBA 函数或子程序签名，我们使用正则表达式解析它们。

示例

请参阅examples文件夹。

构建示例站点

1. pip安装mkdocstrings mkdocstrings-vba
2. cd examples/example1
3. 查看源代码。
4. mkdocs构建
5. cd site/
6. 查看结果。

运行测试

pip install -r test-requirements.txt
python -m unittest

这将运行所有测试。这包括

• 来自tests/的单元测试。
• 来自mkdocstrings_vba/的doctests。
• 来自examples/的完整构建。

代码风格检查

使用black修复代码风格

black .

使用mypy检查类型

mypy .