如何写出专业级OOP程序-----文档注释

由于时间的限制就写一些通用的注释啦》

 @author 姓名
    这个标记将产生一个作者条目,可以使用多个@author注释,每个对应一个作者。
 @version 文本
   这个标记产生版本条目,对当前版本的描述
 @since 文本
   这个标记始于条目。
 @deprecated 文本
   这个将标记类。方法/变量添加一个不再使用的注释。可通过@see 和 @link 标记,使用超链接。
 @see 引用
 标记后,找到需要生成javadoc文档的java文件。执行 javadoc -d docDirectory *.java 命令。
 即可生成文档。但是在我的电脑上生的HTML乱码,我在<head>添加啦<meta charset="utf-8">即可解决。


时间: 2024-10-13 03:37:02

如何写出专业级OOP程序-----文档注释的相关文章

写出内容到xml文档

package gz.itcast.a_dom4j_write; import java.io.File; import java.io.FileOutputStream; import org.dom4j.Document; import org.dom4j.io.SAXReader; import org.dom4j.io.XMLWriter; /** * 第一个写出内容到xml文档 * @author APPle * */ public class Demo1 { public stati

如何为我们的程序编写开发文档——Java文档注释

Java文档注释是用于生成Java API文档的注释,通过在程序中的类.属性.方法部分加上注释,就可以用javadoc命令生成漂亮的API文档,是程序员进阶的必备技能. 注意,文档注释只说明紧跟其后的类.属性或者方法. Javadoc文档生成命令为: -author和-version可以省略. 根据在文档中显示的效果,文档注释分为三部分.举例如下: 第一部分是简述.如下图中被红框框选的部分: 简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号). 第二部分是详细说明部分.该部

跟我学SharePoint 2013视频培训课程——签出、签入文档(9)

课程简介 第9天,怎样在SharePoint 2013中签出.签入文档 视频 SharePoint 2013 交流群 41032413

4年前的随笔---写出高质量程序的要点

从1990年開始敲代码.到如今已经快20年了.总结出写出高质量程序的几个要点: - 1.開始写之前思路越清晰完整越好. - 2.写的过程中代码一定要规范一致,这种代码便于维护和改动.这个规范一致性包括名称.格式.算法等.- 3.发现一处错误,马上回忆有没有可能其他地方具有相同的错误(假设你遵循第2条.就能非常快找到). - 4.多用ASSERT,在我的代码里面,这条语句至少占领了程序总量的1/10. - 5.每写完一段后至少重复看3遍.非常多BUG是非常难用调试器找出来的. - 通过遵循以上规则

[java基础]文档注释

转载自:http://blog.163.com/hui_san/blog/static/5710286720104191100389/ 前言 Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗? 1)// 注释一行   2)/* ...... */ 注释若干行 3)/** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /**   * .........   * .........   */ 这第三种注释有什么用?javado

Java 文档注释

Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息,并输出到HTML文件中. 说明注释,是你更加方面的记录你的程序的信息. javadoc 标签 javadoc工具软件识别以下标签: 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated de

[转]Eclipse 的快捷键以及文档注释、多行注释的快捷键

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释 4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */

Eclipse 的快捷键以及文档注释、多行注释的快捷键

其实快捷键可以自己设定:eclipse>>>window>>>preferences>>>keys Alt + / 内容提示很常用的Ctrl + 1 快速修复 Alt + 方向键 跟踪时向前向后退回前进Ctrl + Alt + 向下键快速复制行 Alt + 向上向下键 快速移动行 Ctrl + T 查看继承关系Ctrl + Shift + T 快速查看方法源代码Ctrl + Shift + O 快速导入引用包 Alt + Shift + A : 快捷键

【转载】Eclipse 的快捷键以及文档注释、多行注释的快捷键

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */ 2.