版權(quán)說(shuō)明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)
文檔簡(jiǎn)介
初識(shí)Java單元一Java概述Java程序運(yùn)行機(jī)制Java程序開(kāi)發(fā)Java注釋目錄CONTENTS12341.4Java注釋1、為什么要有注釋?
假設(shè)一個(gè)程序員新進(jìn)入一個(gè)項(xiàng)目組,接手一個(gè)已離職程序員未完成的軟件模塊功能,當(dāng)他打開(kāi)原程序員編寫(xiě)的代碼時(shí),其中一個(gè)方法可能有上百行代碼,沒(méi)有任何注釋。這樣造成的結(jié)果是,新程序員要花費(fèi)很長(zhǎng)的時(shí)間去理解原程序員的業(yè)務(wù)邏輯和思路,可能還會(huì)出現(xiàn)理解錯(cuò)誤的情況。怎么解決這個(gè)問(wèn)題呢?在一個(gè)規(guī)范化的軟件開(kāi)發(fā)項(xiàng)目組里,程序的編寫(xiě)是必須要有注釋的,Java程序編寫(xiě)也不例外1.4Java注釋2.什么是注釋?
Java程序中的注釋就是方便程序閱讀而寫(xiě)的一些說(shuō)明性的文字。通過(guò)注釋提高Java源程序代碼的可讀性,使得Java程序條理清晰,易于理解。Java的注釋有3種:?jiǎn)涡凶⑨?、多行注釋、文檔注釋。
//
注釋一行
/*......*/注釋若干行/**......*/注釋若干行,并寫(xiě)入javadoc文檔1.4Java注釋3、編寫(xiě)注釋的規(guī)范
(1)注釋要簡(jiǎn)單明了(2)邊寫(xiě)代碼邊注釋?zhuān)薷拇a的同時(shí)修改相應(yīng)的注釋?zhuān)员WC注釋與代碼的一致性(3)保持注釋與其對(duì)應(yīng)的代碼相鄰,即注釋的就近原則,通常是放在該段代碼的上方或者放在該行代碼的右邊(單行注釋?zhuān)?.(4)注釋量要適中。在實(shí)際的代碼規(guī)范中,要求注釋占程序代碼的比例達(dá)到20%左右(5)全局變量要有較詳細(xì)的注釋?zhuān)üδ堋⑷≈捣秶?、方法存取時(shí)的注意事項(xiàng)等說(shuō)明(6)源文件頭部要有必要的注釋信息,包括文件名,版本號(hào),作者,生成日期,模塊功能描述,主要方法清單及本文件歷史修改記錄等(7)方法前面要有必要的注釋信息,包括方法名稱(chēng),功能描述,輸入、輸出及返回值說(shuō)明,拋出異常等1.4Java注釋下面是第一個(gè)Java程序增加注釋后的完整程序。/***CopyRightInformation :blue-dot*Project :blue-bridge*JDKversionused :jdk1.8.0*Author :JackYang*Version :2.1.0,2021/11/1**/publicclassHelloWorld{/***Description:主函數(shù),程序入口*@paramString[]args*@returnvoid*/publicstaticvoidmain(String[]args){System.out.pri
溫馨提示
- 1. 本站所有資源如無(wú)特殊說(shuō)明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒(méi)有圖紙預(yù)覽就沒(méi)有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。
最新文檔
- 2026年渤海船舶職業(yè)學(xué)院?jiǎn)握芯C合素質(zhì)筆試備考試題含詳細(xì)答案解析
- 2026安徽皖信人力資源管理有限公司招聘安慶市某電力外包人員1人參考考試試題及答案解析
- 2026年蘭州外語(yǔ)職業(yè)學(xué)院高職單招職業(yè)適應(yīng)性測(cè)試備考題庫(kù)及答案詳細(xì)解析
- 2026年硅湖職業(yè)技術(shù)學(xué)院?jiǎn)握芯C合素質(zhì)筆試備考試題含詳細(xì)答案解析
- 2026年桂林電子科技大學(xué)單招綜合素質(zhì)筆試參考題庫(kù)含詳細(xì)答案解析
- 2026年唐山職業(yè)技術(shù)學(xué)院?jiǎn)握新殬I(yè)技能考試模擬試題含詳細(xì)答案解析
- 2026年濰坊理工學(xué)院高職單招職業(yè)適應(yīng)性測(cè)試備考題庫(kù)及答案詳細(xì)解析
- 2026年鄭州理工職業(yè)學(xué)院高職單招職業(yè)適應(yīng)性測(cè)試備考題庫(kù)及答案詳細(xì)解析
- 2026年南昌健康職業(yè)技術(shù)學(xué)院高職單招職業(yè)適應(yīng)性測(cè)試備考試題及答案詳細(xì)解析
- 2026年常州機(jī)電職業(yè)技術(shù)學(xué)院?jiǎn)握芯C合素質(zhì)考試備考試題含詳細(xì)答案解析
- 眼科護(hù)理與疼痛管理
- 急性冠脈綜合征再灌注治療
- 2026年中國(guó)聚苯乙烯行業(yè)市場(chǎng)深度分析及發(fā)展前景預(yù)測(cè)報(bào)告
- 43-麥肯錫-美的集團(tuán)績(jī)效管理模塊最佳實(shí)踐分享
- 航空發(fā)動(dòng)機(jī)的熱管理技術(shù)
- 電商平臺(tái)一件代發(fā)合作協(xié)議
- 2025年綜合行政執(zhí)法部門(mén)招聘《職業(yè)能力綜合應(yīng)用能力》模擬試卷及答案
- 學(xué)前奧數(shù)考試題型及答案
- 屋面光伏陽(yáng)光棚施工方案
- 海島型景區(qū)游客環(huán)境責(zé)任行為的影響機(jī)制研究-三亞蜈支洲島景區(qū)為例
- 助貸中介居間合同范本
評(píng)論
0/150
提交評(píng)論