PHP 扩展包实战教程 - 从入门到发布
1. 序言 2. 开发环境 3. 写作约定 4. 什么是 PHP 扩展包? 5. Composer 基础使用 6. 拓展包的基础结构 7. 需求分析与功能设计 - 天气 SDK 8. 准备工作 - 创建开放平台应用 9. 创建项目并安装依赖包 10. 从接口获取天气数据 11. 异常与错误处理 12. 编写单元测试 13. 测试我们的拓展包 14. 为 Laravel 集成优化 15. 编写友好的说明文档 16. 发布上线 17. 发布第一个版本 18. 代码重构实践 19. 使用 Travis-CI 做自动化测试 20. 使用 StyleCI 自动修复代码格式 21. 扩展包案例赏析 - EasySMS 22. 课程总结 23. 扩展开发推荐阅读清单 24. 作品分享和学习感悟
Menu

编写友好的说明文档

我们的包就已经可以发布了吗?并没有,一个优秀的扩展包应该包含友好的说明文档,所以发布前我们先来完善说明文档,开源项目一般是在项目根目录创建 README.md 作为使用文档,当然,如果你的项目过于复杂,那么你可能需要将文档放到项目 docs 文件夹下,我们这里主要介绍普通复杂度的扩展包文档的编写。

一份友好的文档应该包含下面这些信息:

  • 项目简介及创作动机
  • 项目维护、CI、依赖更新状态(如果有)
  • features & 适用人群
  • 运行的平台或硬件要求
  • 重要依赖
  • 如何安装与测试
  • 使用示例及文档地址
  • 贡献指南
  • License
  • 鸣谢
  • 其它特有的信息

比如我们的扩展包的 README 信息就可以像下面这样来编写:


Weather

基于 高德开放平台 的 PHP 天气信息组件。

安装

$ composer require overtrue/weather -vvv

配置

在使用本扩展之前,你需要去

本文章首发在 Laravel China 社区

为了保证课程的高品质,我们需要对课程进行收费。付费后 才能观看剩余内容。 购买

上一篇 下一篇
刻意练习,每日精进。
13
点赞
1335
浏览
1
讨论

作者