[玩转系统] 编辑清单

作者：精品下载站日期：2024-12-14 02:26:53 浏览：16 分类：玩电脑

编辑清单

这是撰写新文章或更新现有文章时适用的规则摘要。有关这些规则的详细说明和示例，请参阅贡献者指南中的其他文章。

元数据

ms.date：格式必须为MM/DD/YYYY
- 当有重大或事实更新时更改日期
  - 重新整理文章
修复事实错误
添加新信息

如果更新无关紧要，请勿更改日期

修复拼写错误和格式

title：长度为 43-59 个字符的唯一字符串（包括空格）

不包含站点标识符（它是自动生成的）

使用句子大小写 - 仅将第一个单词和任何专有名词大写

描述：115-145 个字符，包括空格 - 此摘要显示在搜索结果中

格式化

段落内内联出现的反引号语法元素
- Cmdlet 名称动词-名词
变量$counter
语法示例动词-名词-参数
文件路径C:\Program Files\PowerShell、/usr/bin/pwsh
文档中不可点击的 URL
属性或参数值

对属性名称、参数名称、类名称、模块名称、实体名称、对象或类型名称使用粗体

粗体用于语义标记，而不是强调

粗体 - 使用星号 **

斜体 - 使用下划线 _

仅用于强调，不用于语义标记

第 100 列换行（或 about_Topics 为 80 列换行）

无硬制表符 - 仅使用空格

行中没有尾随空格

PowerShell 关键字和运算符应全部小写

对 cmdlet 名称和参数使用正确的 (Pascal) 大小写

标头

H1 是第一个 - 每篇文章只有一个 H1
仅使用 ATX 接头
所有标题均使用句子大小写
不要跳过级别 - 没有 H2 就没有 H3
H3或H4最大深度
前后空行
PlatyPS 在其架构中强制执行特定标头 - 不要添加或删除标头

代码块

前后空行
使用标记的代码围栏 - powershell、输出或其他适当的语言 ID
未标记的栅栏 - 语法块或其他 shell
将输出放在单独的代码块中，但您不希望读者使用复制按钮的基本示例除外
查看支持的语言列表

列表

正确缩进
第一项之前和最后一项之后的空白行
项目符号 - 使用连字符 (-) 而不是星号 (*) 来减少强调的混乱
对于编号列表，所有数字均为“1”。

术语

PowerShell 与 Windows PowerShell
查看产品术语

Cmdlet 参考示例

cmdlet 参考中必须至少有一个示例
示例应该是足以演示用法的代码
PowerShell语法
- 使用 cmdlet 和参数的全名 - 无别名
当命令行太长时，使用splatting作为参数
避免使用续行反引号 - 仅在必要时使用

删除或简化 PowerShell 提示符 (PS>)，示例需要的除外

Cmdlet 参考示例必须遵循以下 PlatyPS 架构

### Example 1 - Descriptive title

Zero or more short descriptive paragraphs explaining the context of the example followed by one or
more code blocks. Recommend at least one and no more than two.

```powershell
... one or more PowerShell code statements ...
```

```Output
Example output of the code above.
```

Zero or more optional follow up paragraphs that explain the details of the code and output.

不要在代码块之间放置段落。所有描述性内容必须位于代码块之前或之后。

链接到其他文档

在文档集外部或 cmdlet 参考和概念之间进行链接时
- 链接到 Microsoft Learn 时使用站点相对 URL（删除 https://learn.microsoft.com/en-us）
不要在 Microsoft 属性的 URL 中包含区域设置（例如，从 URL 中删除 /en-us）
所有指向外部网站的 URL 都应使用 HTTPS，除非这对目标网站无效

在文档集中链接时