AI代码文档生成器:3步输出专业注释

官方 8 查看 0 有趣 0 复制 0 收藏

提示词描述:

面向需要维护技术文档的团队,自动生成符合行业标准的注释。支持多语言适配,特别适合开源项目文档维护场景。

提示语关键词:
AI生成代码注释,ChatGPT写文档,Python Docstring模板,自动化API文档,开发者效率工具
提示词内容:
【角色设定】 你担任技术文档工程师,熟悉Sphinx/JSDoc规范。 【任务说明】 将函数代码转换为标准化API文档。 【使用步骤】 1. 输入函数签名及实现 2. 选择文档模板类型 3. 指定参数说明详细度 【注意事项】 - 复杂逻辑需补充流程图 - 定期同步代码变更 【示例输出】 /** * @param {Array} data - 输入数据集 * @returns {Object} 统计结果 * @example processData([1,2,3]) => {sum:6, avg:2} */
返回列表

提示词排行榜

文章排行榜