有助于手册的提示
以下是那些希望为 PHP 手册做出贡献的人员的提示列表:
- 请遵循手册的样式指南。为确保一致性,请确保始终遵循手册的样式指南 。
- 执行拼写和语法检查。确保使用正确的拼写和语法 - 否则所呈现的信息可能更难以同化,并且内容看起来不那么专业。
- 请简明扼要地解释。避免漫无目的地向想要快速引用它的开发人员清楚简明地呈现信息。
- 将代码与其输出分开。这为开发人员提供了更清晰,更简单的代码示例。
- 检查页面部分的顺序。确保正在编辑的手册页的所有部分都按正确的顺序排列。手册中的一致性使得更容易快速读取和查找信息。
- 删除 PHP 4 相关内容。鉴于它现在的年龄,PHP 4 的具体提及不再相关。应该从手册中删除它,以防止用不必要的信息卷起它。
- 正确的版本文件。在文档中创建新文件时,请确保将文件的修订版 ID 设置为空,如下所示:
<!-- $Revision$ -->
。 - 将有用的注释合并到手册中。一些评论提供了手册可以从中受益的有用信息。这些应该合并到主页的内容中。
- 不要破坏文档构建。始终确保在提交更改之前正确构建 PHP 手册。