Java语言方法文档
示例
所有Javadoc注释均以一个块注释开头，后跟一个星号（/**），并在该块注释出现（*/）时结束。（可选）每行可以以任意空格和一个星号开头；生成文档文件时将忽略这些文件。
/**
* Brief summary of method, ending with a period.
*
* Further description of method and what it does, including as much detail as is
* appropriate. Inline tags such as
* {@code code here}, {@link some.other.Docs}, and {@literal text here} can be used.
*
* If a method overrides a superclass method, {@inheritDoc} can be used to copy the
* documentation
* from the superclass method
*
* @param stream Describe this parameter. Include as much detail as is appropriate
* Parameter docs are commonly aligned as here, but this is optional.
* As with other docs, the documentation before the first period is
* used as a summary.
*
* @return Describe the return values. Include as much detail as is appropriate
* Return type docs are commonly aligned as here, but this is optional.
* As with other docs, the documentation before the first period is used as a
* summary.
*
* @throws IOException Describe when and why this exception can be thrown.
* Exception docs are commonly aligned as here, but this is
* optional.
* As with other docs, the documentation before the first period
* is used as a summary.
* Instead of @throws, @exception can also be used.
*
* @since 2.1.0
* @see some.other.class.Documentation
* @deprecated Describe why this method is outdated. A replacement can also be specified.
*/
public String[] read(InputStream stream) throws IOException {
return null;
}
热门推荐
10 祖国生日祝福语简短英文
11 护士辞职送行祝福语简短
12 婆婆生日祝福语短语简短
13 学生宴祝福语简短的
14 对女友的简短祝福语
15 幼儿狗年祝福语大全简短
16 结婚对白誓言简短祝福语
17 航空公司祝福语简短
18 月子小孩祝福语大全简短