有个梨UGlee
2019-12-21 21:07:27 发布
当一个库项目基本完成代码和基础覆盖测试之后,应该考虑在这个项目里写一个有实际意义的demo,使用这个库。有实际意义的意思的可以实际使用而不仅仅是一个十几行的代码例子。
在写这个demo的过程里,你需要暂时忘记一下库的内部结构,尝试从两个角度来使用库。
第一,基于文档,例如对js来说就是jsdoc生成的文档,根据文档去使用API,发现文档不清晰的地方添加文档。
第二,考虑调试,例如js里有debug库,在实际写demo的时候考虑如何让调试这个demo更容易,底层或者内部可以如何打印得恰到好处,站在使用者的角度最关心那些事件、行为、和数据流。
这样在demo完成后,项目的文档和可调试性会被完善,期间也可能发生一些重构;到这部完成,项目才可以真正的alpha release。