檢測過時的描述

開發人員文件通常在每個文件中包含描述。這些描述可能會過時，導致混亂和不正確的資訊。為了防止這種情況，您可以使用一些 AI 和 GenAIScript 來自動偵測文件中過時的描述。

Markdown 和 frontmatter

許多文檔系統使用 markdown 格式來編寫文檔，並使用「frontmatter」標頭來儲存元資料。這是帶有 frontmatter 的 markdown 文件的範例：

---
title: "My Document"
description: "This is a sample document."
---

# My Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

目標是建立一個腳本來偵測 frontmatter 中的描述欄位何時過時。

劇本

GenAIScript 旨在在檔案上運行，並提供一個特殊變數 env.files，其中包含要分析的檔案清單。您可以使用該變數透過 def 函數將檔案包含在上下文中。我們將每個檔案限制為 2000 個令牌，以避免大檔案上的內容爆炸。

// Define the file to be analyzed
def("DOCS", env.files, { endsWith: ".md", maxTokens: 2000 })

下一步是給腳本分配任務。在本例中，檢查 frontmatter 中的內容和描述欄位是否符合。

// Analyze the content to detect outdated descriptions
$`Check if the 'description' field in the front matter in DOCS is outdated.`

最後，我們利用內建的診斷產生功能為每個過時的描述建立錯誤。

// enable diagnostics generation
$`Generate an error for each outdated description.`

在 Visual Studio 程式碼中執行

將此腳本儲存到工作區後，您將能夠透過上下文選單在檔案或資料夾上執行它
選擇運行 GenAIScript...。

自動化

您可以在文件檔案上自動執行此工具，以使用 cli 識別過時的描述。

npx --yes genaiscript run detect-outdated-descriptions **/*.md

此腳本可以整合到您的 CI/CD 管道中以自動執行偵測過程。

以上是檢測過時的描述的詳細內容。更多資訊請關注PHP中文網其他相關文章！