下面截圖是絕大部分介面中類似的一部分
稍好一點的介面如下:
說明介面用途,只要引數名稱和實際意義相同.但是依舊有問題
比如查詢獲取剩餘每日額度,如果額度為0,那麼返回值是null還是new bananaquota()呢.對於方法呼叫者來說,需要知道方法做什麼,方法需要什麼,需要注意什麼,返回值代表什麼.如果方法定義時候無法提供,那麼呼叫者就需要了解方法的實現細節,而對於呼叫者而言根本就是浪費時間.
如果方法呼叫者需要知道的內容無法知曉,那麼就需要了解具體的實現細節.對於接手開發或者後期維護人員,除了知道用途,根據引數名稱檢視引數意義,成功的返回值.特殊實現思路需要自己花費時間閱讀,這些都是最初開發者最熟悉的,只完成功能實現,卻沒有為後來人準備.
介面作用,引數,以及引數特殊說明,方法的特殊實現思路,特殊情況的返回值介紹,對閱讀介面而言足夠.
lua原始碼注釋 1
最近讀了點lua的原始碼，打算記錄下來，將來也知道自己這一段幹了啥。其實我以前也試圖讀過lua原始碼，不過一直沒有找對下手方向，比如我一直試圖從main下手，這個是錯誤的，還沒有進行正題，就被一大堆初始化給搞暈了，加之決心不大，就這樣一直拖著沒有看。不過最近因為工作的原因，熟悉了lua的c api，...
報錯 1 常見報錯注釋
1.command not found 命令沒有找到 2.no such file or directory 沒有這個檔案或目錄 3.permission denied 許可權不足 4.no space left on device 磁碟沒有剩餘空間 5.file exists 檔案已經存在 6.i...
Struts 2 注釋教程1
struts 2 注釋例子 我們將通過基於struts 2的hello user的例子學習注釋。在這個例子中，我們將獲得使用者的名字並給使用者展示乙個歡迎的資訊。這裡有兩個版本的例子，第乙個我們將了解到如何使用struts2提供的智慧型預設功能來實現，我們除了部署描述符 descriptor 以外，...