一些寫library的practices分享

我寫library/module通常有一d practices。

1) 我多數是將data store的底層abstract。
並且default使用memory data store。(e.g:用個hashmap儲住就算)

我咁做唔係因為懶/求奇。
而係因為我自己作為developer理念係minimum-viable就是最簡單,就是最好。
面向developer,其實最好就係用最快最簡單最少step方法就可以俾developer taste得到。
default使用memory data store,就至少唔駛setup database。

但我通常亦都會留位俾developer去switch用其他data store implementation。
我通常都會另外做一個堅database data store implementation 俾佢next step即刻可以switch到。
最近寫的code,我有時會再另外再做一個remote REST resource data store implementation。

2) 我多數都會做埋self contain的minimum-runnable helloworld samples。
我擺上github果堆library,我都一定會寫埋readme Document。
但developer好多時同時好需要sample as a reference去抄抄貼貼黎用,會快過佢地自己齋對住readme doc/API doc黎由零砌起。
砌一d minimum-runnable helloworld samples,佢可以踢著黎試/trace/改code黎自己去研究點玩點用。

3) Document, test case, 依d基本野唔駛講。

Leave a Reply

Your email address will not be published.