Javadoc

What Does Javadoc Mean?

Javadoc is a documentation tool for the Java programming language. The document it creates from the Java sources is in HTML format and describes the application programming interface.

Advertisements

Techopedia Explains Javadoc

Javadoc uses the delimiters “/**” and “*/” to open and close comments, respectively. Various tags and parameters are used for different types of documentation such as for describing an author (“@author”), the version of a class or interface (“@version”), a method parameter (“@param”), the return value (“@return”), a link to other documentation (“@see”), etc. Javadoc generates output from four different types of source files, namely, source code files, package comment files, overview comment files and miscellaneous unprocessed files.

Advertisements

Related Terms

Margaret Rouse
Technology Expert

Margaret is an award-winning technical writer and teacher known for her ability to explain complex technical subjects to a non-technical business audience. Over the past twenty years, her IT definitions have been published by Que in an encyclopedia of technology terms and cited in articles by the New York Times, Time Magazine, USA Today, ZDNet, PC Magazine, and Discovery Magazine. She joined Techopedia in 2011. Margaret's idea of a fun day is helping IT and business professionals learn to speak each other’s highly specialized languages.