架構(gòu)組-文檔總結(jié)

架構(gòu)組-文檔總結(jié)

包圖規(guī)范

類(lèi)圖規(guī)范

NS圖規(guī)范

架構(gòu)圖規(guī)范

宏觀出發(fā)

局部細(xì)節(jié)

包圖規(guī)范

1. 格式

包

2. 關(guān)系

泛化

依賴

3. 元素

類(lèi)

接口

構(gòu)件

節(jié)點(diǎn)

協(xié)作

用例

其他包或圖

4. 可見(jiàn)性

“+” ：public

“-” ：private

“#” ：protected

5. 繪制原則

每個(gè)包都必須有一個(gè)唯一的包名

包圖中擁有的元素不得超出規(guī)范中的六種元素

最小化包間的依賴，最小化每個(gè)包中的 public , protected 元素個(gè)數(shù)，最大化每個(gè)包中 private 元素個(gè)數(shù)

包間關(guān)系不能出現(xiàn)循環(huán)依賴的情況

包中可以嵌套子包

包圖需體現(xiàn)出包間的層級(jí)關(guān)系，一個(gè)層級(jí)的包放到一張圖。一般情況下，只繪制第一層級(jí)的包關(guān)系即可。

6. 示例

類(lèi)圖規(guī)范

1. 格式

接口

抽象類(lèi)

類(lèi)

2. 關(guān)系

繼承：實(shí)線+空心三角 繼承父類(lèi)

實(shí)現(xiàn)：虛線+空心三角 實(shí)現(xiàn)接口

組合：實(shí)線+實(shí)心菱形 成員變量

聚合：實(shí)線+空心菱形 成員變量

關(guān)聯(lián)：實(shí)線+箭頭 成員變量

依賴：虛線+箭頭 局部變量、方法的參數(shù)或者對(duì)靜態(tài)方法的調(diào)用

3. 標(biāo)準(zhǔn)

1.類(lèi)間關(guān)系的格式與描述要做到準(zhǔn)確無(wú)誤，緊密貼合代碼，與代碼保持一致。

2.符合UML規(guī)范。

3.在UML基礎(chǔ)上，不能有二義性，圖要能表達(dá)出來(lái)明確的含義。

4.統(tǒng)一，整體看著整潔，一致，比如關(guān)系：繼承和實(shí)現(xiàn)關(guān)系縱向畫(huà)，其他關(guān)系橫向畫(huà)。

NS圖規(guī)范

1. 結(jié)構(gòu)

順序結(jié)構(gòu)

表示程序中的個(gè)操作是按照他們出現(xiàn)的先后順序執(zhí)行的

選擇結(jié)構(gòu)

表示程序的處理步驟出現(xiàn)了分支，他需要根據(jù)某一特定的條件選擇其中的一個(gè)分支執(zhí)行。選擇結(jié)構(gòu)有單選擇、雙選擇的多選擇三種形式

循環(huán)結(jié)構(gòu)

直到型循環(huán)：表示從結(jié)構(gòu)入口處直接執(zhí)行循環(huán)體，在循環(huán)終端處判斷條件，如果條件不滿足，返回入口處繼續(xù)執(zhí)行循環(huán)體，直到條件為真時(shí)再退出循環(huán)到達(dá)流程出口處，是先執(zhí)行后判斷。因?yàn)槭?直到條件為真時(shí)為止"，所以稱為直到型循環(huán)。

當(dāng)型循環(huán)：表示先判斷條件，當(dāng)滿足給定的條件時(shí)執(zhí)行循環(huán)體，并且在循環(huán)終端處流程自動(dòng)返回到循環(huán)入口；如果條件不滿足，則退出循環(huán)體直接到達(dá)流程出口處。因?yàn)槭?當(dāng)條件滿足時(shí)執(zhí)行循環(huán)"，即先判斷后執(zhí)行，所以稱為當(dāng)型循環(huán)。

注意事項(xiàng)

圖形清晰、整齊

全局到局部思路來(lái)畫(huà)

必須要有返回的結(jié)果，并且返回內(nèi)容顯示明確

不允許出現(xiàn)不屬于圖的元素，如指向線和注釋標(biāo)簽

架構(gòu)圖規(guī)范

宏觀出發(fā)

整體結(jié)構(gòu)

色彩搭配

局部細(xì)節(jié)

用詞表達(dá)

是否全面

模塊劃分粒度

模塊擺放以及層級(jí)關(guān)系

圖形間距離適中，避免間距過(guò)大、過(guò)小，影響美觀

UML

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。