課程
/后端開發(fā)
/Java
/Java入門第一季(IDEA工具)升級版
javadoc為什么要生成,有什么作用,在什么情況下需要生成?有哪位大神能不能詳細介紹一下javadoc到底是怎么回事,謝謝。
2017-05-17
源自:Java入門第一季(IDEA工具)升級版 2-12
正在回答
當(dāng)我們的項目很大,編寫了很多代碼的時候,就需要生成一個標(biāo)準(zhǔn)的API文檔,讓后續(xù)的開發(fā)人員,或者合作者可以清晰的了解您方法的使用.
打開java代碼,編寫JavaDoc 注釋,只有按照java的規(guī)范編寫注釋,才能很好的生成API文檔,javadoc注釋與普通注釋的區(qū)別為多一個*(星號)。普通代碼注釋為/*XXX*/,而javadoc的注釋為/**XXX*/
javadoc注釋要盡量寫的詳細,這樣別人在沒有源碼的情況下才知道如何使用您的代碼。
舉報
0基礎(chǔ)萌新入門第一課,從Java環(huán)境搭建、工具使用、基礎(chǔ)語法開始
1 回答javadoc
1 回答javadoc標(biāo)記
4 回答關(guān)于javadoc
1 回答javadoc怎么用
1 回答請問為什么我加載javadoc出問
Copyright ? 2025 imooc.com All Rights Reserved | 京ICP備12003892號-11 京公網(wǎng)安備11010802030151號
購課補貼聯(lián)系客服咨詢優(yōu)惠詳情
慕課網(wǎng)APP您的移動學(xué)習(xí)伙伴
掃描二維碼關(guān)注慕課網(wǎng)微信公眾號
2017-05-17
當(dāng)我們的項目很大,編寫了很多代碼的時候,就需要生成一個標(biāo)準(zhǔn)的API文檔,讓后續(xù)的開發(fā)人員,或者合作者可以清晰的了解您方法的使用.
打開java代碼,編寫JavaDoc 注釋,只有按照java的規(guī)范編寫注釋,才能很好的生成API文檔,javadoc注釋與普通注釋的區(qū)別為多一個*(星號)。普通代碼注釋為/*XXX*/,而javadoc的注釋為/**XXX*/
javadoc注釋要盡量寫的詳細,這樣別人在沒有源碼的情況下才知道如何使用您的代碼。