勵志

勵志人生知識庫

javadoc的作用

描述類或者方法

JavadocSun公司提供的一個技術,它可以從程式原始碼中抽取類、方法、成員等注釋,形成一個與原始碼配套的API幫助文檔。在編寫程式時,使用一套特定的標籤作注釋,程式編寫完成後,通過Javadoc可以同時形成程式的開發文檔。Javadoc的主要作用是描述類或者方法的作用,它可以在類上面和方法上面編寫。通過Javadoc,可以針對整個方法或者整個類做一個簡要的概述,使得別人不通過看具體方法代碼就能知道某個方法或者某個類的作用和功能。