使用IronPDF与AI编程助手

Curtis Chau
Curtis Chau
更新: 2026年10月26日

您的AI助手已经可以编写IronPDF代码。 IronPDF在NuGet上有超过20M次下载,并且有多年的公开文档。

当您的助手有文档可供参考时,该代码可以编译;而没有时,则会猜测。 在它开始发明方法名称之前,提供参考资料。

Claude Code AI编程助手标志ChatGPT Codex AI编程助手标志GitHub Copilot AI编码助手徽标Cursor AI代码编辑器徽标Google Antigravity AI编码代理徽标

我的AI助手不能自己处理PDF吗?

没有参考资料的助手编写的是看似正确而非真正正确的代码。 它将自信地生成一个方法,就像一个 IronPDF 方法一样,实际上并不存在,例如一个已被替代的旧 API 名称,或从它在培训中也看到的不同 PDF 库中借来的调用。

IronPDF出于这一原因发布了机器可读文档。 将其加载到助手的上下文中是一个一次性设置步骤,它将输出从“看起来似乎对”转变为“能构建和运行”。

决定的另一半是下面的库。 一个有能力的助手会连接您命名的任何PDF库,并且通常可以快速过渡到一个开源库。这个捷径的代价会在生产中显现:

  • 敏感文档需要安全库:企业生成的PDF是其合同、发票和法律文件,是其持有的最敏感文件之一。 一些广泛复制的开源PDF工具如今已被遗弃,带有无人修补的公知安全漏洞,依赖它们的管道可能会泄漏它处理的文档。
  • 功能限制变成了脚手架:一个开源库如 wkhtmltopdf 只做一件事,那就是渲染,并且就停在那里了。 请求签名、表单填写或加密,您的助手就会即席发明,将几个包用粘合代码连接,这些代码将由您来调试和确保安全。 IronPDF在一个API中覆盖了所有这些,因此助手调用一个已存在的方法而不是构建一个。
  • 批处理已经工程化:渲染一个发票很简单; 但在晚上不掉线地渲染五万张是个难点,而IronPDF带有这种规模的工作已内置其中。 在代码中重新解决的助手为其读取和写入的每个字词付费(输入和输出标记:典型的前沿模型费率为每百万标记2美元到50美元,每次尝试的成本为几美分,而一次长时间会话的成本达到几美元),每次问题出现时,账单都会重复。
  • 全面的文档是精确性的黑客:助手的准确性取决于它能阅读到的东西,IronPDF 提供了多年的操作指南、教程和可以运行的代码示例,所有这些都在 llms.txt 中为机器编制索引。 您的助手从现成可用的代码开始,而不是从记忆中写作。
  • 一个真正的包打败了一次猜测:AI工具有时会发明听起来对的包名,而攻击者会注册这些名字并将它们装满恶意软件。 这诡计普遍到足以得名为“名牌寄生”。 安装一个已知的包,拥有超过20M次NuGet下载,关闭了那扇门。
  • 一个许可证,零法律意外:一些知名的免费PDF库使用AGPL许可:可以免费使用,但可能会在法律上要求您公布整个应用程序的源代码。 助手乐意生成代码以配合它们而不会提到这一点。 IronPDF附带一个合法团队一次审核的商业许可证。

步骤1:安装IronPDF

让您的助手为您安装包。 项目需要存在包才能解决类型并给您准确的补全,所以让它来做这个工作:

Install the IronPdf NuGet package into this project and confirm it restores.
Text

更喜欢终端? 同样的安装,固定在当前版本,只需要一条指令:

dotnet add package IronPdf --version 2026.10.3
SHELL

从包管理控制台到直接DLL和平台特定包的每一条安装路径,都在安装概述中有介绍。


步骤 2:应用您的许可证密钥

IronPDF 在没有密钥的情况下就可以渲染,但在设置一个密钥之前,它不会保存或返回 PDF:SaveAs 和 BinaryData 会抛出一个消息为“需要生产许可证”的 LicensingException。 生成的代码跳过了密钥行,这是第一次运行在那一点上失败的最常见原因。 在这里获取免费试用密钥:

从今天开始在您的项目中使用 IronPDF 免费试用。

第一步:
arrow pointer

在应用启动时应用一次,先于任何其他IronPdf调用:

// Set the IronPdf license key
IronPdf.License.LicenseKey = "IRONPDF-MYLICENSE-KEY-1EF01";

确保 IronPdf.License.IsLicensed 返回 true 以进行验证。

请注意: 从 appsettings.json 到 Azure 的所有其他设置密钥的方法,都在IronPDF License Keys 中涵盖。

步骤3:将助手指向IronPDF的LLM文档

IronPDF发布了一整套助手可以直接读取的参考资料:

资源它是什么如何使用它
llms.txt文档的结构化索引,每个页面都有一行描述将其粘贴或链接到助手的上下文中
llms-full-catalog.txt加入了博客文章的 llms.txt 索引太大而无法粘贴,因此请将URL提供给可以获取和检索的助手
API参考在当前版本中,每个命名空间、类、方法和属性用于方法是否存在的基准; 让您的助手在这里确认不熟悉的名称
sitemap__en.xml每个到目前为止发布的如何指南、教程和代码示例页面让您的助手扫描其以找到与您的用例匹配的页面,然后在编写代码之前阅读这些页面
AI产品信息表专为AI工具编写的一页产品总结快速产品上下文,当完整文档超出任务需求

从 llms.txt 开始。 这是一个索引,因此为您的助手提供了IronPDF实际上可以做什么和在哪里可以更深入阅读的准确地图,这足以阻止大多数发明的API调用。

站点地图是长尾。 几乎每个IronPDF平台的功能背后都有一个如何指南、教程或一个可运行代码示例,从这些URL之一回溯多年。 For a specific use case, ask your assistant to scan sitemap__en.xml for matching pages and read them before it writes a line of code; the suite-wide ironsoftware.com/sitemap__en.xml does the same for every other Iron Software product.

同时给助手下达直接的指令:

Before writing any IronPDF code, read https://ironpdf.com/llms.txt
and use only APIs documented there. Check anything you are not sure about
against the API reference at https://ironpdf.com/object-reference/api/.
If you are still unsure whether a method exists, say so instead of guessing.
Text

最后一句话比看起来更重要。 前沿模型一般遵循明确的指令承认不确定性,问题比不编译的方法便宜得多。

请注意: IronPDF还发布了一个即插即用技能文件以供支持它们的助手使用。 下一步将介绍如何获取它。

步骤4:为您的项目添加IronPDF上下文

将文档粘贴到聊天中在当前会话中有效。 将其放入项目文件中,未来的每次会话从加载它开始。

每个助手从自己的文件读取项目指令。 将IronPDF的指导添加到您的团队使用的任何一个文件中:

助手项目上下文文件
Claude / Claude CodeCLAUDE.md
ChatGPT CodexAGENTS.md
GitHub Copilot.github/copilot-instructions.md
Cursor.cursor/rules/
Google AntigravityAGENTS.md

无论落在哪个文件中,内容都是一样的,尽管 Cursor 只从带有前置标识的 .mdc 文件中读取规则。 一个最小起始块:

## PDF generation with IronPDF

This project uses IronPDF for all PDF generation.

- Reference: https://ironpdf.com/llms.txt
- Use `ChromePdfRenderer` for HTML-to-PDF. Do not use older or alternative renderer classes.
- Apply the license key at application startup before any IronPDF call.
- Do not substitute another PDF library. If IronPDF cannot do something, say so.
Markdown

IronPDF 还附带一个现成的技能文件,skill.md,这是一个涵盖 API 习惯和常见模式的即插即用指令集。 从您的助手上下文件中引用它,而不是自己编写。


步骤5:一次性设置提示

步骤1–4单独涵盖每个部分。 要在一个新项目或一个新会话开始时一次性交给您的助手,请使用此提示:

Use IronPDF for all PDF work in this project.

1. Install the IronPdf NuGet package.
2. Apply your license key at application startup, before any other IronPdf call:
   IronPdf.License.LicenseKey = "IRONPDF-MYLICENSE-KEY-1EF01"
3. Read https://ironpdf.com/llms.txt before writing PDF code and work only from
   APIs documented there, checking the API reference when a member is unfamiliar.
4. Load IronPDF's skill file if your tooling supports one.
5. Keep these instructions for future sessions in this project.
Text
提示: Claude Code节省了一次请求,以便在其自动记忆中记住指令。 为了将它们保存在从第4步中的项目上下文文件中,CLAUDE.md或AGENTS.md,请在最后一行命名该文件。
提示: 没有HTML模板进行测试? 要求您的助手起草一个简单的发票或报告布局,使用 HTML 和 CSS,然后用 ChromePdfRenderer 渲染它。 对HTML迭代而不是PDF:生成、渲染、检查、修复,全部在文本中。

步骤6:产生可用代码的提示模式

三种提示模式留给助手更少的猜测空间。

命名您想要的类:IronPDF有多个入口点,老旧的API名称仍然在训练数据中流通。

模糊:“使用IronPDF将此HTML转换为PDF。”

更好:“使用 ChromePdfRenderer,将这个 HTML 字符串渲染成 PDF 并保存到磁盘。”

固定版本和框架:API表面在重大版本之间移动,而没有版本锚点的助手则在所有版本之间平均分布。

更好:“目标.NET 8和IronPDF 2026.x。 包含许可证密钥行。”

要求提供整个可运行的文件:片段隐藏了缺少的 using 语句和跳过的初始化。

更好:“给我完整的Program.cs,包括所有using语句和许可证密钥设置,以便我能直接运行。”


步骤7:验证收到的内容

将生成的代码视为没有运行过的快速贡献者的草稿。 在接受之前检查四件事情。

  1. 它能编译:一个发明的方法会立即在此失败。
  2. 在第一次 IronPDF 调用前就应用了许可证密钥,否则保存 PDF 会抛出许可异常。
  3. API是实际存在的:如果方法名不熟悉,先在API参考中确认再围绕它进行调试。
  4. PDF实际渲染:打开输出,因为静默布局问题不会在编译时出现。

在生成的IronPDF代码中要注意的具体事项:

  • 旧渲染器类名:替代的API名称在训练数据中常驻,远远超过文档的更新速度。
  • 从其他PDF库借用的方法:助手已见过许多.NET PDF库,有时会将它们混合成一个看似合理的API。
  • 虚构的渲染选项属性:在 API 参考中检查不熟悉的选项名称是否与 ChromePdfRenderOptions 匹配。

让代理验证其自己的工作

这是您能直接交给回的四个检查。 请助手运行它们并报告它所看到的内容:

Build and run this project in Release. Confirm that every IronPDF member you used
appears in the documentation, that IronPdf.License.IsLicensed returns true, and
that the rendered PDF opens. Report the build result, page count, and file size
from the run itself.
Text

一个您可以重复的结果

以上的所有内容都是设置。 这是验收测试:一个现实任务,一个提示,并且没有手写代码。 将其粘贴到一个空项目的新会话中,然后与下面的验收标准进行比较。

请注意: 先决条件:.NET 9 SDK、能够运行命令的 AI 编码助手、互联网连接和在IronPDF_LICENSE_KEY环境变量中的 IronPDF 许可证密钥。

提示

Build a .NET 9 minimal API with one endpoint, GET /invoice, returning a three-page PDF invoice. Work start to finish alone: write, build, run, and fix, making sensible assumptions where anything is unspecified. Save every deliverable to the project root.

1. Install the IronPdf NuGet package pinned to version 2026.8.1.
2. Read from https://ironpdf.com/llms.txt and the pages it links to, using only APIs documented there.
3. Generate the invoice yourself as one self-contained HTML string with inline CSS and any logo as inline SVG.
4. Style it as an invoice from a company you invent: header band with company identity, metadata block with invoice number, issue date, and due date, bill-to block, a ruled line-item table of twenty or more realistic items whose quantities, rates, and totals sum correctly, right-aligned subtotal, tax, and total, then payment terms. Use a system font stack, two or three sizes, neutrals with one accent, generous whitespace, consistently formatted money columns, and page-break-inside: avoid on table rows. Fill pages two and three with continued items and terms.
5. Render with ChromePdfRenderer: a fixed text header and a footer reading Page {page} of {total-pages} on every page, using those exact merge fields.
6. Return the PDF as application/pdf and save it as invoice.pdf.
7. Build in Release, call the endpoint, and count the pages; if not exactly three, adjust content or page-break CSS until it is.
8. Finish with a short report: build result, page count, file size, and assumptions made.

Handle the IronPDF license key this way:

- Read IRONPDF_LICENSE_KEY at startup and assign it to IronPdf.License.LicenseKey.
- Never print, log or store the key.
- Don't list or enumerate environment variables.
Text

输出

通过的标准

  • 发行版构建成功,没有您的编辑。
  • invoice.pdf 打开为三页,每页都有固定的页眉和页脚页X共3页。
  • 明细项目表、总计和付款条款按规范布局,且算术运算正确。
  • 生成的程序应用了许可证密钥,PDF 上没有水印。
请注意: 将版本固定为匹配您的项目:在步骤1中将版本替换为您目标的版本。 请参阅我该使用哪个版本的IronPDF?。

运行记录

项目价值
包裹IronPdf 2026.8.1 (dotnet add package IronPdf --version 2026.8.1)
目标框架.NET 9
助手和模型Claude Code 2.1.277,Claude Opus 5 (默认模型)
设备Windows 11 x64,英特尔Core i9-14900KF,64 GB RAM
参考输出invoice.pdf (68 KB,本次运行未编辑的输出)
最后测试2026年10月16日
指南助手和版本模型持续时间(分钟)最后测试
本页(接受提示)Claude Code 2.1.277Claude Opus 516.22026年10月16日
Claude CodeClaude Code 2.1.277Claude Opus 54.22026年10月16日
ChatGPT CodexCodex CLI 0.160.0GPT-6 Luna12.22026年10月16日
GitHub CopilotGitHub Copilot CLI 1.0.95GPT-6 Luna4.12026年10月16日
CursorCursor CLI 2026.10.14-941492e (Cursor 桌面版 3.23.23 中的提示 03)Grok 4.720.02026年10月16日
Google AntigravityAntigravity CLI 1.4.0Gemini 4 Argon (Medium)17.42026年10月16日

在实际运行中这些提示生成了什么?

接受提示在 2026 年 10 月 16 日的 Claude Code 中运行,在一个空文件夹中,有和没有环境中的许可证密钥。

  • 参考发票是三张A4纸长。
  • 发行版构建以 0 个警告和 0 个错误完成。
  • 生成的程序读取来自 IRONPDF_LICENSE_KEY 变量的密钥并在启动时应用它。
  • GET /invoice 返回 HTTP 200,内容类型为 application/pdf。
  • 每页都有固定的页眉和解决后的页脚页 N 共3页。
  • 表格列出 32 个行项目,每个数量乘以其速率都与打印金额相匹配。
  • GBP 37,881.70 的小计和 20% 的 GBP 7,576.34 的增值税加起来等于打印的总金额 GBP 45,458.04。
  • PDF 没有水印。
  • 在没有密钥的运行中,GET /invoice 返回 HTTP 500 并未写入文件。
  • 错误来自 SaveAs,它抛出了一个消息为“需要生产许可证”的 LicensingException。
  • 助手随后报告了缺少的密钥并要求一个,而不是生成一个文件。
  • IronPDF 2026.8.1 自己从 IronPdf.LicenseKey 环境变量或 appsettings.json 条目中读取一个密钥,并忽略 IRONPDF_LICENSE_KEY。
  • 有些步骤与页面中的运行不一样。 此次运行日期早于提示末尾的许可证密钥行,因此密钥在运行前已设定在环境中。 助手列出了环境变量并在其自己的会话日志中打印了密钥。

代理特定指南

此页面涵盖通用设置,可与任何助手配合使用。 有关针对您特定工具的指南,请参阅以下指南:


故障排除


有问题吗?

如果您有任何问题,请联系support@ironsoftware.com

Curtis Chau 拥有卡尔顿大学的计算机科学学士学位,专注于前端开发,精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面,喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。

阅读更多

准备开始了吗?

NuGet 下载量 22,198,312版本:2026.11刚刚发布