现在公司用开发给前端用的接口,语言是Java
,现在想定开发规范,然后有些纠结的地方:
一个是接口的名称,之前用的的驼峰的形式,比如myTopic
,但是看网上推荐的有my_topic
,更容易辨识,或者推荐比较多的my-topic
,看到说法是比前一种输入起来更方便。
还有个入参的问题,比如一个接口接受的参数是分页的页数,之前也是习惯性的驼峰的pageNum
,但看很多公司,比如支付宝的接受参数都是page_num
这种。
想问下大家以上两个问题一般用的是那种或推荐哪种?
伊谢尔伦2017-04-18 10:50:21
各家公司都有不同的寫法,甚至一個公司內不同的團隊都會有不同的寫法。
但總有一種大多時候是對的的寫法,那就是駝峰。
駝峰寫法也被實驗驗證過,最容易讓人識別,且識別速度快。可以看這裡駝峰可讀性的研究
怪我咯2017-04-18 10:50:21
風格問題沒有標準答案,你列舉的3種方式都能找到案例。
我個人用的是底線方式 page_num這種,這種的可讀性更好,都使用小寫字母,比較適合url/uri。