程序設計語言和編碼(2)(編輯修改稿)
2025-02-02 18:29 本頁面
【文章內(nèi)容簡介】 23 源程序文檔化 ? 在源程序中可包含一些內(nèi)部文檔，以幫助閱讀和理解源程序 ? 在源程序中的內(nèi)部文檔主要包括： – 標識符的命名 – 注解 – 程序的視覺組織 24 標識符的命名 ? 選擇含義明確的名字，使其能正確提示標識符所代表的實體 – 例如，表示總量的變量名用 Total，表示平均值的用 Average等 ? 名字不要太長，太長會增加打字量，且易出錯。必要時可使用縮寫 ? 不用相似的名字，相似的名字容易混淆，不易發(fā)現(xiàn)錯誤 – 如 cm,cmn,m,n,cmm 25 ? 不用關鍵字作標識符 ? 同一個名字不要有多個含義 ? 名字中避免使用易混淆的字符。如數(shù)字 0與字母 O； 數(shù)字 1與字母 I或 l； 數(shù)字 2與字母 z等 26 程序的注釋 ? 程序中的注解用來幫助人們理解程序，決不是可有可無的 ? 一些正規(guī)的程序文本中，注解行的數(shù)量約占整個源程序的 1／ 3到 1／ 2，甚至更多 ? 注解分為序言性注解和功能性注解 27 ? 通常置于每個程序模塊的開頭部分，主要描述： ? 模塊的功能 ? 模塊的接口：包括調(diào)用格式、參數(shù)的解釋、該模塊需要調(diào)用的其它子模塊名 ? 重要的局部變量：包括用途、約束和限制條件 ? 開發(fā)歷史：包括模塊的設計者、評審者、評審日期、修改日期以及對修改的描述 序言性注釋 28 ? 通常嵌在源程序體內(nèi)，主要描述程序段的功能。 ? 書寫功能性注解時應注意的問題： ? 注解要正確，錯誤的注解比沒有注解更壞； ? 為程序段作注解，而不是為每一個語句作注解； ? 用縮進和空行，使程序與注釋容易區(qū)分； ? 注解應提供一些從程序本身難以得到的信息，而不是語句的重復。 功能性注釋 29 ? 例如，下面的模塊級注釋描述了公共的和私有的過程（在類模塊中稱為 “ 方法 ” ）、屬性及其數(shù)據(jù)類型，以及如何將該類作為對象來使用的有關信息 ： 公共方法： MailAddRecipient(strName As String, Optional fType As Boolean) strName: //要加入到郵件中的收件人名稱。 fType: Outlook MailItem Type //屬性設置。 SendMail(Optional blnShowMailFirst As Boolean) blnShowMailFirst: //發(fā)送前是否顯示 Outlook郵件信息。如果不能解析收件人的地址，讓代碼將它設置為 True。 私有方法： InitializeOutlook() CreateMail() 公共屬性： MailSubject:(Write only, String) MailMessage:(Write only, String) MailAttachments:(Write only, String) 30 ? 通過在程序中添加一些空格、空行和縮進等技巧，幫助人們從視覺上看清程序的結(jié)構 ? 例如，通過縮進技巧可清晰地觀察到程序的嵌套層次，同時還容易發(fā)現(xiàn)諸如 “ 遺漏 end”那樣的錯誤
醫(yī)療健康相關推薦
鄂ICP備17016276號-1