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

 @author 姓名

    这个标记将产生一个作者条目，可以使用多个@author注释，每个对应一个作者。

 @version 文本

 　　这个标记产生版本条目，对当前版本的描述

 @since 文本

　　 这个标记始于条目。

 @deprecated 文本

 　　这个将标记类。方法/变量添加一个不再使用的注释。可通过@see 和 @link 标记，使用超链接。

 @see 引用

 标记后，找到需要生成javadoc文档的java文件。执行 javadoc -d docDirectory *.java 命令。

 即可生成文档。但是在我的电脑上生的HTML乱码，我在<head>添加啦<meta charset="utf-8">即可解决。








												


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

    
								
  1. 如何写Java文档注释(Java Doc Comments)
		
    本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西 本文不讨论如何使用javadoc工具自动生成文档的方法,而是主 ...
    
		
    2. 
						
  2. Java：API文档；文档注释中的javadoc标记；官方API；自己动手给项目建一个API文档
		
    1.什么是API文档 在Java语言中有3种注释 //单行注释 /* 多行注释 */ /** * 文档注释 */ API(应用程序接口)文档就是用javadoc命令提取文档注释生成的,html格式,用 ...
    
		
    3. 
						
  3. 让Myeclipse自动生成的get set方法 自动加上文本注释，并且注释内容包含字段中我们加的文档注释
		
    在进行编码写实体类的时候发现,一个实体类有好多的字段要进行注释,他们都是私有的不能直接访问,我们在写的时候加入的文档注释也起不到效果,但是自动生成的get,set方法的文档注释有不符合我们要求(没有包 ...
    
		
    4. 
						
  4. 如何为我们的程序编写开发文档——Java文档注释
		
    Java文档注释是用于生成Java API文档的注释,通过在程序中的类.属性.方法部分加上注释,就可以用javadoc命令生成漂亮的API文档,是程序员进阶的必备技能. 注意,文档注释只说明紧跟其后的 ...
    
		
    5. 
						
  5. 跟我学SharePoint 2013视频培训课程——签出、签入文档（9）
		
    课程简介 第9天,怎样在SharePoint 2013中签出.签入文档 视频 SharePoint 2013 交流群 41032413
    
		
    6. 
						
  6. iOS文档注释
		
    Eclipse和IntelliJ IDEA系的IDE都有自动生成文档注释的功能,Xcode虽然安装了VVDocument,但是仍然感觉注释的功能不是很完善,于是今天整理了一下书写文档注释的一些用法.  ...
    
		
    7. 
						
  7. Eclipse 的快捷键以及文档注释、多行注释的快捷键
		
    一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷 ...
    
		
    8. 
						
  8. [java基础]文档注释
		
    转载自:http://blog.163.com/hui_san/blog/static/5710286720104191100389/ 前言 Java 的语法与 C++ 及为相似,那么,你知道 Jav ...
    
		
    9. 
						
  9. Java 文档注释
		
    Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息, ...
    
		
    10. 
		

	


随机推荐
	

    
									
  1. 新手笔记-tftp与yum
			
    lspci 查看pci插槽设备 lsusb  查看USB设备 tftp 配置文件 /etc/xinetd.d/tftp tftp 根目录 /var/lib/tftpboot service xinet ...
    
			
    2. 
						
  2. vs错误【C1083 C1854 C4727】的若干解决办法（对预编译文件头的解释）
			
    这几天写程序,无意间把编译中间文件给删了,然后就出现了C1083编译错误. xxx.cpp ..\commen\xxx.cpp(2) : fatal error C1083: 无法打开预编译头文件:“ ...
    
			
    3. 
						
  3. Strange Towers of Hanoi
			
    题目链接:http://sfxb.openjudge.cn/dongtaiguihua/E/ 题目描述:4个柱子的汉诺塔,求盘子个数n从1到12时,从A移到D所需的最大次数.限制条件和三个柱子的汉诺塔 ...
    
			
    4. 
						
  4. Android_Intent意图详解
			
    本博文为子墨原创,转载请注明出处! http://blog.csdn.net/zimo2013/article/details/11863857 1.Intent作用 Intent是一个将要执行的动作 ...
    
			
    5. 
						
  5. window.open打开新页面，并将本页数据用过url传递到打开的页面；需要两个页面；
			
    页面1 <!doctype html> <html lang="en"> <head> <meta charset="UTF-8 ...
    
			
    6. 
						
  6. BCGControlBar使用方法（转）
			
    一.   关于BCGControlBar. BCGControlBar是一个基于MFC的扩展库,您可以通过完全的用户化操作构成一些类似于Microsoft Office 2000/XP/2003和Mi ...
    
			
    7. 
						
  7. WinForm 控件的布局（Dock属性）的注意点
			
    对于Dock属性,添加控件的顺序会影响它们停驻的方式.例如,如果你对窗体添加控件A,指示其停驻填充(Fill), 然后你对窗体添加控件B并指示其停驻顶部(Top),控件B将覆盖控件A的上部.原因就是控 ...
    
			
    8. 
						
  8. The type javax.servlet.http.HttpServletRequest cannot be resolved.
			
    The type javax.servlet.http.HttpServletRequest cannot be resolved. It is indirectly referenced from  ...
    
			
    9. 
						
  9. Struts2拦截器总结
			
    拦截器的本质: 拦截器就是一个类,一个实现了超级接口Interceptor的类.Interceptor接口里定义了三个方法 init(),destory(),intercept().其中inercep ...
    
			
    10. 
						
  10. JavaScript最全的10种跨域共享的方法
			
    在客户端编程语言中,如javascript和ActionScript,同源策略是一个很重要的安全理念,它在保证数据的安全性方面有着重要的意义.同源策略规定跨域之间的脚本是隔离的,一个域的脚本不能访问和 ...
    
			
    11.