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

 @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. 帝国cms内容页模版
			
    <title>[!--pagetitle--]</title> <meta name="keywords" content="[!--pag ...
    
			
    2. 
						
  2. SVN利用Hooks自动发布网站
			
    出于管理需要,也需要在公司内部实现自动发布流程.当开发机提交SVN代码之后,自动同步到测试服务器进行测试. 网络的拓扑简化为: 1台核心SVN服务器,使用的svn管理软件为Subversion Edg ...
    
			
    3. 
						
  3. flash跨域策略文件crossdomain.xml
			
    flash在跨域时唯一的限制策略就是crossdomain.xml文件,该文件限制了flash是否可以跨域读写数据以及允许从什么地方跨域读写数据. 位于www.a.com域中的SWF文件要访问www. ...
    
			
    4. 
						
  4. CSS实现宽高成比例缩放
			
    用js实现一个宽度自适应,高度随着宽度变化而变化的矩形,相信大家肯定都会.无非是js获取一下元素宽度,然后再计算出相应比例的高度,然后赋给元素,但如果要求只用CSS实现呢.         html代 ...
    
			
    5. 
						
  5. The Suspects(并查集求节点数)
			
    The Suspects Time Limit: 1000MS   Memory Limit: 20000K Total Submissions: 28164   Accepted: 13718 De ...
    
			
    6. 
						
  6. ORACLE  case when then
			
    Oracle CASE WHEN 用法介绍 1. CASE WHEN 表达式有两种形式 --简单Case函数 CASE sex WHEN '1' THEN '男' WHEN '2' THEN '女'  ...
    
			
    7. 
						
  7. VC MFC  屏蔽ESC和ENTER键关闭对话框
			
    方法一: 窗体头文件中加入: protected: virtual BOOL PreTranslateMessage(MSG* pMsg); // PreTranslateMessage是消息在送给T ...
    
			
    8. 
						
  8. ROS开发文档
			
    http://docs.ros.org/indigo/api/roscpp/html/classros_1_1NodeHandle.html#af0bf7baa0ab2385275bb657cc358 ...
    
			
    9. 
						
  9. 搭建Hadoop集群 (二)
			
    前面的步骤请看  搭建Hadoop集群 (一) 安装Hadoop 解压安装 登录master, 下载解压hadoop 2.6.2压缩包到/home/hm/文件夹. (也可以从主机拖拽或者psftp压缩 ...
    
			
    10. 
						
  10. 去掉xcode编译warning：ld: warning: directory not found for option '
			
    tyle="margin:20px 0px 0px; font-size:14px; line-height:26px; font-family:Arial; text-align:left ...
    
			
    11.