【正文】 ...................................38 管理類 ............................................................................................................................39 索引類 ............................................................................................................................40 Tab 頁(yè)類 .........................................................................................................................40 響應(yīng)式窗口類 ................................................................................................................40 查詢結(jié)果/報(bào)表類 ...........................................................................................................406 提示信息規(guī)范 ...................................................41 總則 .........................................................................................................................................41 提示信息 .................................................................................................................................417 熱鍵定義、幫助及使用規(guī)范 .......................................41 總則 .........................................................................................................................................41 規(guī)范 .........................................................................................................................................418 單元測(cè)試規(guī)范（從開(kāi)發(fā)人員角度） .................................42 總則 .........................................................................................................................................42 測(cè)試規(guī)范 .................................................................................................................................429 配置管理規(guī)范（從開(kāi)發(fā)人員角度） .................................43 總則 .........................................................................................................................................43 開(kāi)發(fā)前的準(zhǔn)備 .........................................................................................................................43 開(kāi)發(fā)過(guò)程中的規(guī)則 .................................................................................................................4410 程序模板 .....................................................44 總則 ....................................................................................................................................44 字典模板 ............................................................................................................................454 / 49 單據(jù)模板 ............................................................................................................................45 查詢模板 ............................................................................................................................4511 其他規(guī)則及建議 ...............................................465 / 491 導(dǎo)言 目的本文檔是為基于 Microsoft174。公司的 Visual Studio .Net174。其目的是：? 保證軟件開(kāi)發(fā)過(guò)程中有一個(gè)統(tǒng)一的標(biāo)準(zhǔn)可以進(jìn)行參照：包括類庫(kù)、公共接口、設(shè)計(jì)模式、命名規(guī)范等。 術(shù)語(yǔ)定義可訪問(wèn)性修飾符：public（公有） 、internal（內(nèi)部公有） 、proected（受保護(hù)）、protected internal（受保護(hù)或內(nèi)部公有） 、private（私有） 。非私有包括：公有、內(nèi)部公有、受保護(hù)、受保護(hù)或內(nèi)部公有。 Visual Studio .Net 2022174。編寫源代碼最基本的目標(biāo)是能夠經(jīng)過(guò)編譯生成可執(zhí)行程序。這就如寫文章的句讀、段落、章節(jié)等類似，如果沒(méi)有一種良好的書(shū)寫風(fēng)格和習(xí)慣，不僅僅會(huì)使寫出的文章難以閱讀，而且可能會(huì)造成不少曲解。此外，作為一個(gè)協(xié)作密切的開(kāi)發(fā)團(tuán)隊(duì)，非常有必要保持一致的代碼書(shū)寫風(fēng)格，它有助于團(tuán)隊(duì)開(kāi)發(fā)保持高效（溝通交流、代碼閱讀、工作交接、工作延續(xù)性等方面） 。 framework 中定義的命名空間放在最上面，然后根據(jù)與當(dāng)前代碼關(guān)系的遠(yuǎn)近依次排列，對(duì)于引用的命名空間，按照引用來(lái)源分段列示，段與段之間用空行分隔。using 。using 。using 。31 使用的命名空間代碼示例在類型定義部分，一個(gè)代碼文件原則上只包含一個(gè)如下類型的定義：類、接口、結(jié)構(gòu)、枚舉。對(duì)于委托的定義，可考慮在一個(gè)代碼文件中集中定義內(nèi)聚度較高的一類枚舉。為使類型具有良好的封裝性，其中字段類型只能聲明為 private。每行代碼只允許寫一條語(yǔ)句。傳統(tǒng)的注釋風(fēng)格：?jiǎn)涡凶⑨尫?hào)“//”和多行注釋符號(hào)“/* */”在 C中依然可以使用。8 / 49單行注釋，即形式為“//”的注釋。如對(duì)局部變量聲明的注釋或代碼行、代碼段的注釋。單行注釋也可以用于臨時(shí)屏蔽不用的代碼行，在開(kāi)發(fā)完畢后應(yīng)及時(shí)清理。多行注釋，即形式為“/* */”的注釋。多行注釋可用于臨時(shí)屏蔽不用的代碼行，在開(kāi)發(fā)完畢后應(yīng)及時(shí)清理。這些標(biāo)記包括如下表的全部?jī)?nèi)容：文檔標(biāo)簽 用法示意 功能說(shuō)明summary summarydescription/summarydescription：對(duì)象的摘要。使用 remarks 以提供有關(guān)類型本身的信息。description：參數(shù)的說(shuō)明。paramref paramref name=name/name：引用的參數(shù)名?？梢蕴幚?XML 文件，從而用某種獨(dú)特的方法格式化該參數(shù)。編譯器檢查到給定異常存在后，將 member 轉(zhuǎn)換為輸出 XML 中的規(guī)范化元素名。9 / 49description：異常使用條件說(shuō)明。returns 標(biāo)記應(yīng)當(dāng)用于方法聲明的注釋，以描述返回值。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。使用 seealso 指示希望在“請(qǐng)參閱”一節(jié)中出現(xiàn)的文本。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。使用 see 從文本example exampledescription/exampledescription：代碼示例。一般情況下，這將涉及到 code 標(biāo)記的使用。為您提供了一種將說(shuō)明中的文本標(biāo)記為代碼的方法。 記為您提供了一種將多行指示為代碼的方法。value 標(biāo)記使您得以描述屬性。然后，應(yīng)該手動(dòng)添加 value 標(biāo)記以描述該屬性所表示的值。用于諸如 remarks 或 returns 等標(biāo)記內(nèi)，使您得以將結(jié)構(gòu)添加到文本中。filename39。tagpath[name=id]39。該文件名可用路徑加以限定。 39。 Tagpath： filename 中指向標(biāo)記名的標(biāo)記路徑。 39。 name 注釋前邊的標(biāo)記中的名稱說(shuō)明符；名稱具有一個(gè) id。這是除了將文檔注釋直接置于源代碼文件中之外的另一種可選方法。有關(guān)自定義 include 使用的方法，請(qǐng)參閱 XPath 文檔。將此 id 括在雙引號(hào)中 ( )。 description：目符號(hào)列表或編號(hào)列表中的項(xiàng)或者 term 的定義。定義表時(shí)，只需為標(biāo)題中的項(xiàng)提供一個(gè)項(xiàng)。創(chuàng)建定義列表時(shí)，既需要指定 term 也需要指定 text。列表或表所擁有的 item 塊數(shù)可以根據(jù)需要而定。編譯器檢查到給定代碼元素存在后，將 member 轉(zhuǎn)換為輸出 XML 中的規(guī)范化元素名。 description 成員的訪問(wèn)的說(shuō)明。 使您得以指定對(duì)成員的訪問(wèn)。remarks 標(biāo)記是可以描述有關(guān)類或其他類型的備注概述信息。11 / 49// ===============================================================================// 浪潮GS產(chǎn)品// 功能用途定義。// ===============================================================================// 日期 版本 修改人 描述// ===============================================================================// 作者// 日期// 浪潮集團(tuán)山東通用軟件有限公司版權(quán)所有。// ===============================================================================32 代碼文件注釋示例 類型定義注釋在類型定義時(shí)，需要添加該類型的功能用途說(shuō)明的注釋。使用“summary/”標(biāo)簽，內(nèi)部可根據(jù)需要添加適當(dāng)?shù)臉?biāo)簽，以便更清楚的表達(dá)。用于為調(diào)用者創(chuàng)建see cref=ISecurityServiceClient/。/para/// para若調(diào)用的是c()/c方法，是獲取小節(jié)中的strongUsingClient/strong屬性指定的服務(wù)實(shí)現(xiàn)。功能用途使用“summary/”標(biāo)簽。示例如下：/// summary/// 獲取指定配置的安全管理服務(wù)調(diào)用接口。對(duì)應(yīng)于配置項(xiàng)中的strongCode/strong屬性。/returns/// exception cref=SecurityException如果是程序識(shí)別的錯(cuò)誤，將會(huì)拋出該類型的異常。/// /remarks/// examplecode/// ISecurityServiceClient serviceClient = /// ()。示例如下：// 檢查輸入有效性if (user == null) throw new SecurityException()。// 獲取事件代理，發(fā)出用戶將被修改的事件().FireUserModifying(user)。37 代碼段注釋代碼示例 代碼書(shū)寫風(fēng)格