讀古今文學網 > 程序員必讀之軟件架構 > 結構 >

結構

保持簡單,每個想要描述的元素都只給一小段,如果對讀者有幫助的話,還可以包含圖表。舉個例子,一個高層次的UML類或序列圖有助於解釋內部定制框架如何工作。抵擋住包含所有細節的誘惑,不要覺得你的圖表需要展示一切。我喜歡花上幾分鐘時間勾畫一個展示了選定(重要)屬性和方法的高層次的UML類圖,而不是使用UML工具或IDE插件從你的代碼庫自動生成的複雜圖。任何圖都保持在一個較高層次的細節意味著著它們能在更長時間內較少變動,保持最新,因為它們能夠忍受代碼的微小變化而仍然有效。