格式指南

来自Agatha纯净生存文档中心

指令部分

一个指令的介绍页面应包含以下要素:

  • 参数
  • 功能
  • 备注

参数

应包含一个指令运行的必要参数和非必要参数,必要参数使用<>标记,非必要参数使用[]标记。语句应使用引用块。也要包含对参数的说明。

功能

应包含指令的作用。

备注

应包含指令别名、使用注意事项(一定要写清楚,避免 //fixwater 400)、使用要求(在哪里使用、什么情况使用)等要素。