Log in
GoFrame官网 - 类似PHP-Laravel, Java-SpringBoot的Go企业级开发框架
Spaces
Hit enter to search
Help
Online Help
Keyboard Shortcuts
Feed Builder
What’s new
Available Gadgets
About Confluence
Log in
Sign up
GoFrame社区团队
Page tree
Browse pages
Configure
Space tools
A
t
tachments (0)
Page History
Page Information
Resolved comments
View in Hierarchy
View Source
Export to PDF
Export to Word
Pages
GoFrame社区团队
框架可维护性
Jira links
可维护性建设:示例完善
Created by
郭强
, last modified on
Dec 12, 2021
感兴趣参与框架建设的小伙伴请通过微信或者QQ联系
郭强
报名。
目的
针对框架中一些已经非常稳定的组件,需要进一步完善使用示例的中文文档。
通过
Example
代码的方式,既完善了文档,也同时在仓库中增加了代码示例、进一步完善了框架的单元测试覆盖率。
如何编写
第一步,拉取主库
master
分支代码。查阅源码方法以及注释,框架源码保证代码质量和可维护性,代码阅读起来赏心悦目。
第二步,写
Example
代码。关于如何编写
Example
代码请参考:
代码示例
第三步,
Example
代码完成后提交
PR
到主库,经过一定时间的
CodeReview
后没有问题则会被合并到主库的
master
分支。
第四步,将
Example
代码完善到对应的官网中文文档中。中文文档以示例为主,可以有多个示例描述该方法如何使用,文档排版请参考:
数据校验-校验规则
参考资料
Example
代码编写视频介绍:
https://www.bilibili.com/video/BV1k44y1i7fM/
完善工作
示例完善:一期
Content Menu
No labels
Overview
Content Tools
{"serverDuration": 143, "requestCorrelationId": "18a5be567d05b873"}