ChatGPT脚本参数文档提示词怎么生成不同风格版本

浅枫姑娘_4731

浅枫姑娘_4731

2026-06-25

1002人浏览

原创

cli工具文档需分三类生成:--help输出须纯文本、祈使句、无换行;man页须groff格式、含指定section;swagger json schema须小驼峰字段、无自然语言描述。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

chatgpt脚本参数文档提示词怎么生成不同风格版本

你需要为同一套脚本参数生成三类正式文档:命令行 --help 输出需严格对齐终端显示、man 手册页要适配 groff 渲染、API 接口文档得嵌入 Swagger JSON Schema 字段。直接让 ChatGPT “写参数说明” 会混用口语化描述和模糊限定词,比如把 “--timeout 可选” 写成 “建议你加上这个参数”,导致下游工具解析失败或 CI 构建报错。

生成终端友好型 --help 文档

第一步:在提示词开头明确角色与约束——“你是一名 CLI 工具开发者,正在为 Python 脚本 myscript.py 编写 --help 输出内容,只输出纯文本,不加任何解释、不带代码块标记、不换行描述”。【若不锁死输出格式,ChatGPT 会自动插入 Markdown 表格或缩进空行,终端无法正确截断】

第二步:强制指定字段结构——“按以下顺序组织:首行是命令摘要;空一行后写 Usage 模板(形如 myscript.py [OPTIONS] );再空一行后列出所有参数,每行格式为 --option, -o      描述文字,其中描述必须用祈使句且≤15字”。

第三步:注入真实参数样例——“参数包括:--input, -i 输入文件路径;--verbose, -v 增加日志输出级别;--dry-run 启用模拟执行模式”。这一步操作起来很简单,直接把脚本里 argparse.add_argument() 的实际调用复制进去就行。

Ask Gemini/ChatGPT
Ask Gemini/ChatGPT

用于在用户想通过浏览器自动化与 Google Gemini 或 ChatGPT 交互时。触发短语包括“ask Gemini”“ask ChatGPT”“ask GPT”“让...”。

下载

生成 man 手册页兼容文本

方法一:用 groff 风格锚定语法
在提示词中写:“请生成符合 man 手册第1节规范的纯文本,要求:① 标题行格式为 ‘MYSRIPT(1)’;② SECTION 必须包含 NAME、SYNOPSIS、DESCRIPTION、OPTIONS、SEE ALSO;③ OPTIONS 下每个参数用 .TP 缩进,描述文字前不加冒号,结尾不加句号”。

方法二:反向校验法
追加指令:“生成后,请自查是否满足:所有长选项(--xxx)必须出现在短选项(-x)之前;每个 .TP 条目后必须空一行;SEE ALSO 行必须写成 ‘myscript(1), config.json(5)’ 格式”。

生成可嵌入 Swagger 的 JSON Schema 片段

直接输入:“你是一位 OpenAPI 3.0 规范工程师,请将以下参数转为 JSON Schema object 属性定义:--input 是必需字符串,格式为 file-path;--verbose 是布尔值,默认 false;--dry-run 是布尔值,默认 false。输出仅含 properties 字段内容,不包外层 schema 或 components,字段名用小驼峰(inputPath/verboseMode/dryRunEnabled)”。

这一步必须禁用自然语言描述——删掉所有“该参数用于……”“表示是否……”这类句子,否则 Swagger UI 无法识别字段类型。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

chatgpt

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

2026.10.10

80

15

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

2026.10.10

40

15

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

20

15

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

2026.10.10

20

26

C++类与对象的封装方法教程
C++类与对象的封装方法教程

C++封装是面向对象编程的核心特性之一,通过类将数据与操作数据的函数组织在一起,并利用访问权限控制外部访问。本专题介绍类的定义、成员变量、成员函数以及public、private和protected的使用方法,帮助初学者掌握封装的基本原理。

2026.10.10

20

32

C++构造函数定义与调用方法
C++构造函数定义与调用方法

C++构造函数用于初始化类对象,是面向对象编程的重要基础。本专题从构造函数的定义、声明和调用入手,介绍默认构造函数、带参数构造函数、拷贝构造函数及成员初始化列表,帮助初学者掌握对象创建与初始化的基本方法。

2026.10.10

20

16

Kratos框架零基础入门教程
Kratos框架零基础入门教程

本专题整理Kratos框架入门内容,涵盖Go环境准备、kratos CLI安装升级、new命令创建项目、目录结构分层说明、服务启动与双协议端口、依赖下载报错排查,帮助开发者快速跑通第一个Kratos框架微服务应用。

2026.10.10

20

15

C++条件判断语句怎么写
C++条件判断语句怎么写

C++条件判断是控制程序执行流程的重要基础。本专题介绍if、if-else、else if和switch等常见分支语句,结合条件表达式、比较运算符与代码示例,帮助初学者掌握不同场景下的判断逻辑。

2026.10.10

20

13

C++变量怎么声明和赋值
C++变量怎么声明和赋值

C++变量是编写程序和存储数据的基础。本专题围绕变量声明、定义、初始化、赋值和类型选择等内容展开,帮助初学者理解不同变量的用法,并掌握在实际代码中定义和使用变量的方法。

2026.10.10

20

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
ChatGPT入门手册
ChatGPT入门手册

共0课时 | 0人学习

ChatGPT使用教学
ChatGPT使用教学

共2课时 | 207人学习