Eclipse用法和技巧四：生成说明文档1

写代码经常要添加注释的，java代码的注释也可以分为两种。单行注释以“//”作为开头就可以。段落注释在第一行开头添加“/*”，在最后一行结尾添加“*/"即可。这里介绍一种添加注释的方法，其注释的数据域和方法，能在Eclipse环境下，在调用处显示出来。上图：

步骤一：在要添加说明的方法上一行输入"/**"

步骤二：回车

步骤三：查看效果

补充说明下：这种添加注释的方法专门为JavaDoc设计，可以被JDK内置的JavaDoc工具支持和处理。JavaDoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过JavaDoc就可以同时形成程序的开发文档了。
怎么通过JavaDoc形成程序的开发文档就是接下来要介绍的。

上一篇文章，Eclipse用法和技巧三：自动生成Main方法2：
http://blog.csdn.net/ts1122/article/details/8769426

下一篇文章，Eclipse用法和技巧五：生成说明文档2 ：
http://blog.csdn.net/ts1122/article/details/8798127

Eclipse用法和技巧四：生成说明文档1相关推荐

Eclipse用法和技巧五：生成说明文档2
上面一篇文章里面我们介绍了一种生成可以被JDK提取到,生成JavaDoc的添加注释方法.下面再补充一种生成这种注释的方法,上图: 步骤一:光标移动到需要添加注释的语句旁边,快捷键:shift + al ...
Eclipse用法和技巧十四：自动生成的TODO注释2
前面介绍了自动生成的TODO注释含义,配置以及如何去除的方法,这里介绍下TODO常见的用途.工作中经常会遇到写代码写到一半,被叫过去开会推动沟通.o(╯□╰)o 一般都有写代码停下来一段时间,再回来就 ...
Eclipse用法和技巧六：自动生成get和set方法1
java的类中,除了常量声明为静态且公有的,一般的对象数据作用域,都是声明为私有的.这样做能保护对象的属性不会被随意改变,调试的时候也会方便很多:在类的公有方法中大一个调用栈就能看到哪里改了属性值.声 ...
Eclipse用法和技巧十三：自动生成的TODO注释1
使用eclipse的快捷键自动生成的代码,经常有这样的注释. 一眼看上去这个注释和一般的注释并无什么差别,不过TODO这个字符串的颜色不一样,应该有些内容.TODO是eclipse中提供的一种任务标签 ...
Eclipse用法和技巧七：自动生成get和set方法2
上一篇文章中我们介绍了自动批量生成get和set函数的方法.这个方法一般在声明完类的数据域之后使用,比较方便快捷.这里再补充几个自动生成get和set函数的方法. 步骤一:在声明的数据域中按Ctrl+ ...
Eclipse用法和技巧十五：自动添加未实现方法1
java代码中经常要实现一些接口,这个也是java代码独有的地方.实现接口,就意味着要实现这个接口中定义的方法,如果一个个去码出方法就需要记得方法名称等等,就算有内容辅助快捷键帮助,也是很麻烦的.这里 ...
Eclipse用法和技巧二十三：查看JDK源码
使用java开发,如果能阅读JDK的经典代码,对自己的水平提高是很有帮助的.笔者在实际工作中总结了两种阅读JDK源码的方式.第一种下载android源代码,直接在android源码代码中,这里的代码虽 ...
Eclipse用法和技巧十八：减少不必要的输入
写代码的时候,很多人都有一个原则,尽量上输入.依靠IDE自动生成的代码,一般可读性,排版什么的都还是不错的,最主要的一般不会有什么低级错误.今天介绍几个在eclipse环境中,常用的依靠eclipse ...
Eclipse用法和技巧十二：快速复制一行
写代码的总有那么个时候需要Ctrl+c,Ctrl+v,在eclipse中如果遇到需要快速在一行代码的上下复制一行的话,有很方便的快捷键可以使用.将光标放到某一行,按住Ctrl+Alt+Down,即可以 ...

Eclipse用法和技巧四：生成说明文档1

Eclipse用法和技巧四：生成说明文档1相关推荐

最新文章

热门文章