過時程式員的部落格

本來另還打算寫一篇，「多寫文檔」的，但想了一下，還是不要了，做人不要自欺欺人。做內部開發的，天天開會聊需求，日日在改系統，晚晚在加班，誰會有時間來寫幾乎不會有人看的文檔？每個新入職的都希望公司內部都能有一套自己系統的開發文檔和使用手冊……誰沒天真過呢？遇到比較好的程序員，他可能還可以交出一點點文檔，但絕對都是過時的。系統上線後就要開始應付各種微調要求、數據調整、用戶培訓，還有用戶一堆哭笑不得的問題，哪有時間更新文檔？一般都是在交付系統或上線前交過一份，往後就不再怎麼更新了。

但，為了安心休假，還是得留一點的資訊給隊友或後來者，否則你的工作就永遠都交不出去。這時候，備註就很重要了。代碼裏的備註不用很詳細，大多一兩句就夠，務求簡單易明，複雜的還是需要做個簡單文檔放到部門公用盤。

我的備註都這樣寫：
這樣寫在開頭，讓隊友一打開就看到，也能了解：
// 20211224: Sam: Update <table> with server time
// 20211226: John: Request by Sales Mary, add checking before delete order

這樣寫在中間，讓隊友可以拷貝前面的日期搜找到相關的代碼位置：
// 20211224
Update user_mst 
Set time_udpate = :ldt_server time
Where user_no = :ls_user_no 
Using sqlca;

我建議備註都用英文，因為誰都不知道接手的會是什麼國籍的人，加上英文放到不同語言平台都不容易出現亂碼，畢竟在電腦世界，英文還是主流，會寫代碼的人多少都會懂一點點。