使用 IronPDF 與 AI 編碼助理
您的 AI 助理已經可以編寫 IronPDF 程式碼。 IronPDF 已經擁有超過 20M 的 NuGet 下載次數和多年的公開文檔。
當您的助理有文檔可參考時,那些代碼能夠編譯成功,而當沒有參考時則是猜測。 在它開始發明方法名稱之前,先提供參考資料給它。
如何使用 IronPDF 與 AI 編碼助理
- 從 NuGet 下載 C# PDF 庫
- 在應用程式啟動時套用您的授權金鑰
- 指引您的助理到 IronPDF 的
llms.txt文檔索引 - 將 IronPDF 的說明添加到您的專案上下文檔案中
- 在新會話中運行單次設置提示
- 確認生成的代碼可以編譯並渲染
我的 AI 助理不能自己處理 PDFs 嗎?
沒有參考資料的助理寫出的代碼是貌似合理而非正確的。 它將自信地產生一個方法,像 IronPDF 方法一樣閱讀,不存在,例如被取代的舊 API 名稱,或從其訓練中看到的不同 PDF 庫借來的調用。
IronPDF 發布可機器閱讀的文檔正是出於這個原因。 將它加載到您的助手上下文中是一次性的設置步驟,這會將輸出從“看起來正確”變成“能夠構建和運行”。
決策的另一半在於底層的庫。 一個有能力的助理會將您指定的任何 PDF 庫整合起來,並且它通常可以在生產環境中完成開源庫的簡化處理:
- 敏感文件需要安全的庫:企業生成的 PDF 是它的合約、發票和法律文件,是它擁有的最敏感的文件之一。 當今有幾個廣為人知的開源 PDF 工具被廢棄,公認的安全漏洞無人修補,基於它們構建的管道可能會洩漏其處理的文件。
- 功能限制變成鷹架:像 wkhtmltopdf 這樣的開源庫只做一件事,渲染,然後停止。 要求簽名、填寫表單或加密等功能時,您的助理即興發揮,將幾個包整合在一起,並使用需要您除錯和安全的黏合代碼。 IronPDF 在一個 API 中涵蓋了所有這些,因此助手調用的方法已經存在,而不是構建一個新的。
- 批量處理已經過設計:渲染一張發票很簡單; 而在不崩潰的情況下隔夜渲染五萬張發票則是難題,IronPDF 提供了內建的此類規模的處理。 重做的助手在代碼中重新解決此問題,每讀寫一個字都要付費(輸入和輸出標記:典型的前沿模型價格為每百萬標記 2 美元至 50 美元,每次嘗試花費數美分,長期進程跑到數美元),並且每次問題出現時帳單就會重複。
- 廣泛的文檔是準確性的竅門:助手的準確性只取決於它能閱讀的內容,而 IronPDF 為其提供多年來的指南、教程和可運行的代碼範例,所有這些都在
llms.txt中為機器索引。 您的助手從現成的代碼開始,而不是從記憶中寫作。 - 真實包勝過猜測包:AI 工具有時會發明出聽起來合適的包名稱,而攻擊者會註冊這些名稱並且用惡意軟體填充它們。 這個技巧夠常見,甚至有了自己的名稱“slopsquatting”。 安裝 1 個已知的擁有超過 20M NuGet 次數的包就能關上那扇門。
- 一個授權,零法律驚喜:一些知名的免費 PDF 庫使用 AGPL 授權:免費使用,但它可能會合法要求您公開整個應用程式的源代碼。 一個助理會愉快地針對它們生成代碼,而不提及這一點。 IronPDF 採用商業授權,您的法律團隊審查一次即可。
步驟 1:安裝 IronPDF
讓您的助理為您安裝該包。 因為要了解類型規定並正確地填補,項目中需要包的存在,所以讓它來完成此工作:
Install the IronPdf NuGet package into this project and confirm it restores.
偏愛控制台嗎? 相同的安裝,固定在當前版本,是一條命令:
dotnet add package IronPdf --version 2026.10.3
從包管理器控制台到直接的 DLL 和平台特定包的其他所有安裝路徑,都在 安裝概覽中涵蓋。
步驟 2:套用您的許可證金鑰
IronPDF 在無密鑰的情況下渲染,但是直到設置密鑰後才會保存或返回 PDF:SaveAs 和 BinaryData 將擲出具有信息“需要生產許可”的 LicensingException。 生成的代碼跳過密鑰行是首次運行在該點失敗的最常見原因。 在此處獲取免費試用金鑰:
立即在您的項目中開始使用 IronPDF,免費試用。
在應用程式啟動時套用它一次,在任何其他 IronPdf 調用之前:
// Set the IronPdf license key
IronPdf.License.LicenseKey = "IRONPDF-MYLICENSE-KEY-1EF01";' Set the IronPdf license key
IronPdf.License.LicenseKey = "IRONPDF-MYLICENSE-KEY-1EF01"' Set the IronPdf license key
IronPdf.License.LicenseKey = "IRONPDF-MYLICENSE-KEY-1EF01"確保 IronPdf.License.IsLicensed 退回 true 以進行驗證。
appsettings.json 到 Azure 的每一種設定密鑰方法都包含在 IronPDF 授權密鑰 中。步驟 3:指引您的助理到 IronPDF 的 LLM 文檔
IronPDF 發布了一整套助理可以直接閱讀的參考資料:
| 資源 | 它是什麼 | 如何使用它 |
|---|---|---|
llms.txt | 檔構架索引,其中包含每頁的一行描述 | 將其粘貼,或連接到助理的上下文中 |
llms-full-catalog.txt | 附加了博客文章的 llms.txt 索引 | 太大無法粘貼,因此將 URL 提供給可以抓取和檢索的助理 |
| API 參考 | 當前版本中的每個命名空間、類別、方法和屬性 | 用於確認方法是否存在的基準 讓您的助理在此確認不熟悉的名稱 |
sitemap__en.xml | 迄今為止發布的每個指南、教程和代碼範例頁面 | 讓您的助理掃描與您的使用案例相符的頁面,然後在編碼前閱讀這些頁面 |
| AI 產品資料單 | 為 AI 工具編寫的一頁產品摘要 | 當完整文檔超過任務需求時的快速產品上下文 |
從 llms.txt 開始。 這是一個索引,所以它為您的助理提供了 IronPDF 真正能做什麼和在哪裡閱讀更多內容的準確地圖,這夠能阻止大多數發明的 API 調用。
網站地圖是長尾。 IronPDF 提供的幾乎每個功能背後都有一個指南、教程或可運行的代碼範例,溯回多年。 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.
最後一句話比表面看起來更重要。 前沿模型通常會遵從明確的指示來承認不確定性,而一個問題比一個無法編譯的方法便宜得多。
步驟 4:將 IronPDF 上下文添加到您的專案中
將文檔粘貼到聊天室中可以在該會話中使用。 將其放在項目文件中,每次未來會話啟動時都會加載它。
每個助理從其自己的文件中讀取項目指示。將 IronPDF 的指導添加到您的團隊正在使用的文件中:
| 助理 | 專案上下文文件 |
|---|---|
| Claude / Claude Code | CLAUDE.md |
| ChatGPT Codex | AGENTS.md |
| GitHub Copilot | .github/copilot-instructions.md |
| Cursor | .cursor/rules/ |
| Google Antigravity | AGENTS.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.
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.
ChromePdfRenderer 渲染它。 關注 HTML 而不是 PDF:生成、渲染、檢查、修復,完全在文本中進行。步驟 6:產生可運行程式碼的提示模式
三個提示模式讓助手少一些猜測的餘地。
命名您想要的類別:IronPDF 有不止一個進入點,舊的 API 名稱在訓練數據中仍在流通。
模糊:“使用 IronPDF 將此 HTML 轉換為 PDF。”
更好的方案:“使用
ChromePdfRenderer,將這個 HTML 字符串渲染成 PDF 並保存到磁碟。”
固定版本和框架:API 表面在主要版本之間移動,而沒有版本錨的助理則在它們之間平均。
更好:“目標 .NET 8 和 IronPDF 2026.x。 包括授權金鑰行。”
要求整個可運行文件:片段隱藏了遺失的 using 語句和被跳過的初始化。
更好:“給我完整的 Program.cs,包括所有使用語句和授權金鑰設置,這樣我可以直接運行它。”
步驟 7:驗證您收到的內容
將生成的代碼視為來自快速貢獻者的草稿,其尚未運行過。 在您接受之前檢查四件事情。
- 它可以編譯:發明的方法在此立刻失敗。
- 在第一次 IronPDF 調用之前應用授權鑰匙,否則保存 PDF 將擲出授權異常。
- API 是真實的:如果方法名稱不熟悉,先在API 參考中確認它,然後再找錯誤。
- 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.
可重現的結果
以上都是設置。這是驗收測試:一個真實的任務,一個提示,並且沒有手寫代碼。 將其粘貼到空白專案的新會話中,然後將返回內容與下面的合格標準進行比較。
提示
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.
輸出
什麼過關
- 發行版本構建成功,未經您編輯。
invoice.pdf以三頁形式打開,每頁都有固定頁眉和其頁腳,上面寫著“Page X of 3”。- 行項目表、總計和付款條件按照規定佈局,數學計算正確無誤。
- 生成的程序應用了一個授權鑰匙,並且 PDF 沒有水印。
運行記錄
| 項目 | 價值 |
|---|---|
| 包裹 | 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,Intel Core i9-14900KF,64 GB RAM |
| 參考輸出 | invoice.pdf (68 KB,此運行中的未編輯輸出) |
| 已測試 | 2026年10月16日 |
| 指南 | 助手和版本 | 模型 | 時長(分鐘) | 最後測試日期 |
|---|---|---|---|---|
| 此頁面(接受提示) | Claude Code 2.1.277 | Claude Opus 5 | 16.2 | 2026年10月16日 |
| Claude Code | Claude Code 2.1.277 | Claude Opus 5 | 4.2 | 2026年10月16日 |
| ChatGPT Codex | Codex CLI 0.160.0 | GPT-6 Luna | 12.2 | 2026年10月16日 |
| GitHub Copilot | GitHub Copilot CLI 1.0.95 | GPT-6 Luna | 4.1 | 2026年10月16日 |
| Cursor | Cursor CLI 2026.10.14-941492e (Cursor 桌面 3.23.23 的提示 03) | Grok 4.7 | 20.0 | 2026年10月16日 |
| Google Antigravity | Antigravity CLI 1.4.0 | Gemini 4 Argon (中等) | 17.4 | 2026年10月16日 |
在實際運行中,這些提示產生了什麼結果?
接受提示在 2026年10月16日的 Claude Code 中運行,在空資料夾中進行,並且在環境中有和沒有授權鑰匙的情況下。
- 參考發票長三頁 A4 紙。
- 發行版編譯完成,有0個警告和0個錯誤。
- 生成的程序從 IRONPDF_LICENSE_KEY 變量中讀取密鑰,並在啟動時應用它。
- GET /invoice 返回 HTTP 200 並帶有 application/pdf 內容類型。
- 每頁都有固定的頁眉和解決的“Page N of 3”頁腳。
- 表格列出了 32 行項目,每個數量乘以其利率都與列印金額相匹配。
- 英鎊 37,881.70 的小計和 20% 增值稅(英鎊 7,576.34)加起來等於列印的總額(英鎊 45,458.04)。
- PDF 沒有水印。
- 在沒有密鑰的運行中,GET /invoice 返回 HTTP 500 並且沒有寫入文件。
- 錯誤來自 SaveAs,擲出一個 LicensingException,訊息為“需要生產許可”。
- 然後助手報告缺少密鑰,而不是生成文件。
- IronPDF 2026.8.1 自行從 IronPdf.LicenseKey 環境變量或 appsettings.json 項目中讀取密鑰,忽略 IRONPDF_LICENSE_KEY。
- 一些步驟與頁面上運行的不同。 這次運行早於提示末尾的授權密鑰行,因此在運行前密鑰就設置在環境中。 助手列出了環境變量,並在其自己的會話日誌中列印了密鑰。
代理特定指南
此頁面涵蓋了適用於任何助理的通用設置。 要查看針對您的特定工具調整的演練,請參閱下面的指南:
- 使用 Claude Code 使用 IronPDF
- 使用 ChatGPT Codex 使用 IronPDF
- 使用 GitHub Copilot 使用 IronPDF
- 使用 Cursor 使用 IronPDF
- 使用 Google Antigravity 使用 IronPDF
疑難排解
- 在 IronPDF 中應用授權鑰匙:如果保存 PDF 擲出授權異常
- 正確初始化 RenderingOptions:如果建議的選項名稱無法解析
- 我應該使用哪個版本的 IronPDF?:在提示和項目文件中固定版本
問題?
如果您有任何疑問,請聯繫support@ironsoftware.com
Curtis Chau 擁有卡爾頓大學計算機科學學士學位,專注於前端開發,擅長於 Node.js、TypeScript、JavaScript 和 React。Curtis 熱衷於創建直觀且美觀的用戶界面,喜歡使用現代框架並打造結構良好、視覺吸引人的手冊。