用中文命名API的意義和途徑

此文將從軟件使用者的角度闡述對API中文化的意義並探討實現途徑. 固然, 文中面向的用戶是以中文爲母語的開發者.

首先請看一個實例, 演示效果在此:

這個庫提供了一系列繪圖相關的API. 後者是筆者將這些API封裝成了中文以後的對應代碼.

此文的大前提是, 對以中文爲母語的開發者, 中文接口版本的代碼更易理解.

API做爲程序和程序之間交流的"語言", 在軟件生態圈中的重要性不言而喻. 擁有一套設計良好, 易於理解的API是大多數流行框架和庫共有的特徵. 固然, 絕大多數的API都是英文的. 致使中文用戶在學習和使用時就要更多地依賴文檔和註釋.

中文API的命名更能被中文用戶接受. 它將直接下降使用者的學習門檻, 並下降維護成本. 固然, 第三方庫對中文字符的支持問題仍然會對這一實踐形成麻煩, 但我的認爲在實踐中解決這些麻煩是下降軟件開發成本付出的代價, 並且解決的越早, 後人越能乘涼.

現狀是, 即便一些國人主創, 且幾乎徹底面向國內用戶的框架, 也沒有中文的API. 這裏絕無指摘之意, 由於冰凍三尺非一日之寒, 更況且這些框架問世之時中文字符的支持程度也遠不現在日.

以在下淺見, 開發中文API的途徑包括:

• 用中文封裝現有的英文API
• 在設計時就首選中文API

若是可以作到在內部代碼和API都使用中文命名, 固然是最理想的, 但我的認爲API的命名是更關鍵的一部分. 中文的命名規範幾乎是空白, 這須要實踐和集體智慧來填補.

封裝現有的英文API也許比較有爭議. 常見的一種觀點是"XX語言的核心庫, 先漢化給我看看". 這是一個尋找切入點的問題. 一個主流編程語言的核心庫, 每每經歷十數年甚至更長時間的積累, 接口不下萬個. 而一些特定領域的庫的API, 接口不過數十個. 領域受衆也是很重要的因素. 有興趣的請在跨界: 哪些中文非IT領域會偏好中文API, 編程/腳本語言?一塊兒探討.