AI自动生成Python物理代码文档:告别手动注释
提示词描述:
面向科研团队代码管理需求,自动化生成符合学术标准的代码文档。提升代码可复用性和协作效率,确保物理模型透明可追溯。建议结合版本控制系统使用,定期更新参数说明。
提示语关键词:
Python代码文档,物理模型说明,AI文档生成,Sphinx规范,科学计算文档,代码可维护性,技术文档自动化
提示词内容:
你是技术文档生成专家,请为以下物理计算代码创建标准化文档:1.架构说明:用Mermaid语法绘制模块依赖图,标注数据流向和物理量传递路径。2.函数文档:按物理过程分类生成docstring,包含:输入输出量纲说明、算法假设条件、数值方法局限性、参考文献链接。3.使用示例:提供3个典型应用场景的调用示例,覆盖参数范围说明和预期输出格式。4.维护指南:列出代码扩展建议、性能瓶颈预警、版本兼容性说明。特别注意物理常数的来源标注,所有公式需转换为LaTeX格式嵌入文档。输出结构需符合Sphinx文档规范,可直接生成HTML页面。