動態組字引擎-han3_ji7_tsoo1_kian3漢字變數、函式英文翻譯加註計畫

編輯歷史

時間 作者 版本
2017-07-17 16:38 – 16:38 (unknown) r0 – r1
顯示 diff
+ 動態組字引擎-han3_ji7_tsoo1_kian3漢字變數、函式英文翻譯加註計畫
+
+ * 工作目的
+ https://github.com/Wikimedia-TW/han3_ji7_tsoo1_kian3_WM/tree/code_vf_H2E
+ 這個branch分支是上游han3_ji7_tsoo1_kian3 主分支(master)的fork,我們專門用來加註任何漢語的變數跟函數成英文,幫助在維基美國總會的工程師安全性code review理解順利
+
+ *使用上首先,你要先有github的帳號。
+ *帳號請給我 shoichi.chou@gmail.com ,我把你加入這個git專案,或者也可以用pull request的方式進行
+ *不會git工具的話,github有線上編輯功能
+
+ 我們先試譯看看吧
+ 參考翻譯(一部分): src/main/java/idsrend/services/IDSrendServlet.java Shoichi (MGdesigner)
+ 認領 (請在後面簽個名):
+ *https://github.com/Wikimedia-TW/han3_ji7_tsoo1_kian3_WM/blob/code_vf_H2E/src/main/java/idsrend/services/IDSrendService.java Freedman
+ *https://github.com/Wikimedia-TW/han3_ji7_tsoo1_kian3_WM/blob/code_vf_H2E/src/main/java/idsrend/services/HttpserverJetty.java Shangkuanlc
+ *https://github.com/Wikimedia-TW/han3_ji7_tsoo1_kian3_WM/blob/code_vf_H2E/src/main/java/idsrend/parser/IDSParser.java
+
+ 後續要譯
+
+ *https://github.com/Wikimedia-TW/han3_ji7_tsoo1_kian3_WM/blob/code_vf_H2E/src/main/java/cc/char_indexingtool/CommonFontNoSearch.java
+ *https://github.com/Wikimedia-TW/han3_ji7_tsoo1_kian3_WM/blob/code_vf_H2E/src/main/java/cc/char_indexingtool/CommonFontNoSearchbyDB.java
+
+
+ *翻譯用註解風格
+ *單行註解,請用"//e"開頭,而且前後各加一個半行空白 ,例如
+ //e 組字式 means IDS
+ * 用 "means" 表示某漢文的甲=英文的A
+ * 多行註解,使用C風格的,而且開頭加上t,如右: /*e */ ,而非 /** */,來跟原始重要註解作區別,範例:
+ /*e an important function
+ This is an important function
+ */
+ *如果原來就有解釋重要描述的多行註解,而你要翻譯它,請隔行再下一個註解,例如:
+ /**
+ 這是一個重要的函式
+ */
+ /*e
+ This is an important function
+ */
+
+ *準則
+ *不能改了以後導致程式碼無法執行
+ *不改程式碼本身,而是對使用漢字的任何變數、函式用註解加註
+ 變數與函式不是以下的東西(註解)的,統統是程式碼,裡面就會有變數與函式:
+ *// 這個很重要
+ */**
+ *這件事情的原理是這樣
+ **/
+ *
+ */*
+ *這裡有重點
+ * */
+
+ *原程式碼的中文註解不一定要翻,如果註解是描述程式運作原因的才需要翻譯。如果你不確定要不要翻譯,那就不用翻譯註解。
+ *原程式碼已經有/** */一類的漢文註解的,覺得有必要翻譯它的話,請用另外加一行 /* */ 的註解
+ *原程式碼沒有註解,然後又很簡短的,可以考慮在原碼的分號之後加上 //註解
+ *就算已經解說、翻譯過的「詞」,如果遙遠的別行再出現一次,請再加註說明一次(最差狀況外國人只能看到一堆「方塊缺碼」,難以看出前面已經用過一次,所以說得這麼作)
+ *資源
+ *翻譯對照表 :專有術語的翻譯,請貼到這上面,作跨檔案的統一
+ *telegram:討論用
+ *教育部閩南語常用辭典