Conversation
|
i like it. |
|
Ich mag es auch |
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| [](https://github.com/MAYCHUI/codellama/actions/workflows/python-package.yml) |
javanio627-bot
left a comment
There was a problem hiding this comment.
Usong Java's Documention Comment
As explained in Part 1 java supports three types of comments. The first two are the /// and the /* */. The third type is called a documentation comment. It begins with the charactet sequence /**. It ends with */. Documention comments allow you to embed information about your program into the program itself. You can then use the javacdoc utility program (supplied with the JDK) to extract the information and put it into an HTML.file. Documentation comments make it conventient to document your programs. You have almost certainly seen documentation that uses such comments because that is the way the java API library was documented. Beginning with JDK9, javadoc. Includes support for modules.
THE javadoc Tags
The javadoc utility recognizes severalctags, including those shown here:
Tags Meaning
@author Identifies the author.
{@code} Displays information as -is, without
processing HTML style, in code front.
@deprecated. Specifies that a program element is
deprecated
{@docroot} Specifies the path to the root directory of
The current documentation.
@exception Identifies an exception thrown by a method
or constructor.
@hidden Prevents an element from appearing in the
Documentation.
{@index} Specifies a term for indexing. {@inheritdoc} Inherits a comment from the immediate
Superclass.
{@link} Inserts an in-line link to another topic.
{@linkplain} Inserts an in-link to another topic, but the
Link is displayed in a plain-text front.
{@literal} Displays information as-is, without process-
ing HTML. styles.
@param Documents a parametersTags Meaning
@provide Documents a service provided by a module
@return Documents a method's return value.
@see Specifies a link to another topic.
@serial Documents a defult serializable field.
@Serialdata Documents the data written by the writeObject
( ) or writeExternal( ) methods.
@serialField Documents an ObjectStreamField component.
@SInCE States the release when specific change was
Introduced.
{@summary} Documents a summary of an item. (Added by
JDK 10.)
@throws Same as @exception.
@uses Documents a service needed by a module.
{@value} Displays the value of a constant, which must
be a static field.
@Version Specifies the version of a program element.
No description provided.