返回值、方法名稱、引數、doc是影響介面清晰度的三大要素。
引數和返回值的結構往往是大家容易忽略的。
如果引數、返回值物件結構太過複雜，會對介面清晰度帶來很大的影響。比如使用乙個包含很多關係
的vo物件，介面的使用者設定的值與介面設計者期望的值無法通過明確的方式來約束，往往採用口頭
的交流形成契約，介面的契約作用削弱了。
建議引數物件的層次不要太深，一層最好，不要包含其他的關係物件，關係物件提取到另外的引數中。
api的命名一定要從業務含義而非技術含義的角度出發，避免業務api的技術化傾向。
api的定義必須首先契合當前的介面設計，在此基礎上做適當的冗餘和超前，即是基於介面設計又高於當前的介面設計；避免閉門造車，脫離實際的api設計。
api的異常定義要仔細斟酌，不能千篇一律；避免過長的異常鏈，適當使用執行時異常，使用展現層異常處理guard機制統一處理。
api的注釋要定義在介面而非實現中，要盡量詳細，實現類中僅注釋與實現相關的說明。
暑期客戶服務培訓的要點
又到了客戶服務的高峰期，翻看了7月份的培訓教材，把培訓的要點做了一下記錄，回憶一下吧，不要忘記了。探索 為客戶著想 think customer 客戶期望 customer expectation 積極傾聽 active listening 提議 完整 complete 實際 realistic 雙...
Kafka設計要點
1 利用os的pagecache 不在程序中維護cache，而是直接寫入磁碟，並定期重新整理到磁碟。使用程序cache的缺點 增加記憶體佔用量 程序重啟時要麼重建cache 很耗時 要麼以空cache執行 初始效能很差 加重編碼負擔，需要維護cache和磁碟上資料的一致性。2 順序寫磁碟 沒有使用b...
PCB emi設計要點
首先，對於大腦裡面一定要清楚乙個概念 在高頻裡面，自由空間的阻抗是377歐姆，對於一般的emi中的空間輻射來說，是由於訊號的迴路到了可以和空間阻抗相比擬的地步，因而訊號通過空間 輻射 出來。了解了這一點，要做的就是把訊號迴路的阻抗降下來。控制訊號迴路的阻抗，主要的辦法是縮短訊號的長度，減少迴路的面積...