是不是看慣了文檔裡的英文接口(API),也在 IDE 裡看慣了自動補全裡的英文接口?
現今的絕大多數 API 的確是英文命名沒錯,但絕非不能或者不應該實現和發佈中文 API 的庫。
這裡用一個簡單的漢字簡繁轉換庫為例。在命名上,API 的方法名、參數名以及類名都用了中文。下面是 Eclipse 中的 Javadoc 彈窗:
這個 Java 庫已經發布到了 Maven 倉庫,可以和其他英文 Java 庫一樣方便地調用。在 GitHub 上搜索”com.github.nobodxbodon”就可以看到不少 pom.xml 文件中依賴了這個庫。
現在國內自研的 API 面向的主要用戶群應該也是國內開發者。即便仍保留英文 API ,如果能另外提供一套中文的,必然更易於國內開發者學習和使用,也可以吸引更多使用者。即使是額外維護一套中文 API,工作量也很有限,相比起為最終用戶帶來的益處,可說是相當值得的。
另外,這個庫的實現代碼中的標識符也都用了中文命名。因為這個庫的使用者和潛在合作開發者應該都會中文。下面是其中的一段主要代碼:
JUnit 測試代碼也都使用了中文命名。其中還引用了另一箇中文 API 的庫,而且那個庫的功能非常通用,多半你的 Java 項目也用得到哦。
項目源碼和庫使用方法在:https://github.com/program-in-chinese/zhconverter
更多中文編程推廣過程內情,請關注“
用中文編程”微信公眾號。閱讀更多 用中文編程 的文章