共用方式為

參與品質改善

你不必是主題專家或文件專家也能貢獻。 如果你看到有機會改進文件，請提交拉取請求並附上你提出的改進方案。 本指南概述了幾種簡單方式，任何人都可以為文件做出品質改進貢獻。

我們專注於這些質量領域：

格式化程式代碼範例

所有程式代碼範例都應該遵循PowerShell內容的 樣式指導方針 。 為了方便起見，此處會以縮寫形式重複這些規則：

  • 所有的程式碼區塊都應該置於三個反引號的程式碼框中（```）。
  • 程序代碼區塊的行長度限制為 90 字元，用於 Cmdlet 參考文章。
  • 程式代碼區塊的行長度限制為 76 字元，適用於 about_* 文章。
  • 避免在PowerShell程式碼範例中使用行接續字元 （`）。
    • 使用噴洒或自然換行機會，例如管道 （|） 字元之後、左大括弧 （}）、括弧 （(） 和括弧 （[） 來限制行長度。
  • 僅包含 PowerShell 提示字元，用於示範不適合直接複製貼上的程式範例。
  • 除非您特別記錄別名，否則請勿在範例中使用別名。
  • 避免使用位置參數。 使用參數名稱，即使參數為位置也一樣。

格式化命令語法

所有散文都應該遵循PowerShell內容的 樣式指導方針 。 為了方便起見，此處會重複這些規則：

  • 一律使用 Cmdlet 和參數的完整名稱。 除非您特別示範別名，否則請避免使用別名。
  • 屬性、參數、物件、類型名稱、類別名稱、類別方法應為 粗體。
    • 屬性和參數值應該用反引號括起來（`）。
    • 當在使用方括號樣式參照類型時，請使用反引號。 例如：[System.Io.FileInfo]
  • PowerShell 模組名稱應該是 粗體。
  • PowerShell 關鍵詞和運算子應該是全部小寫。
  • 針對 Cmdlet 名稱和參數使用適當的 （Pascal） 大小寫。
  • 當您依名稱參考參數時，名稱應為 粗體。
  • 如果您要說明語法，請使用參數名稱搭配連字元。 將參數用反引號包圍。
  • 當您顯示外部命令的範例使用方式時，此範例應該包裝在反引號中。 務必包含外部命令的副檔名。

為了文件的維護性和 Markdown 原始碼的可讀性，我們正將概念性文件逐步轉為使用連結參考，而非內嵌連結。

例如，不要這樣寫：

The [Packages tab](https://www.powershellgallery.com/packages) displays all available
packages in the PowerShell Gallery.

它應該是：

The [Packages tab][01] displays all available packages in the PowerShell Gallery.

備註

當您替換內嵌連結時，請將內容重新排列，使其在 100 個字母處換行。 您可以使用 reflow-markdown VS Code 延伸模組來快速重排段落。

在檔案底部，在鏈接的定義之前新增 Markdown 批注。

<!-- Link references -->
[01]: https://www.powershellgallery.com/packages

請確認：

  1. 每個鏈接都會指向正確的位置。
  2. 不要重複連結參考定義。 如果某個 URL 已經有連結參考定義，請重複使用現有的參考，而不是建立新的。
  3. 連結參考定義位於檔案底部，標記註解後，依數字順序排列。

Markdown 語法檢查

針對其中一個參與存放庫中的任何文章，在 VS Code 中開啟文章會顯示程式碼檢查警告。 請處理您發現的任何警告，但以下情況除外：

請確定行長度，並使用 Reflow Markdown 延伸模組來修正任何長行。

拼寫

儘管我們盡了最大的努力，錯字和拼寫錯誤仍然會出現在文件中。 這些錯誤會使文件更難以理解和進行本地化。 修正這些錯誤會使檔更容易閱讀，特別是對於依賴準確翻譯的非英文演講者。

  • Last updated on