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

 @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. cocos2d-x -------之笔记篇 3D动作说明
			
    CCShaky3D::create(时间,晃动网格大小,晃动范围,Z轴是否晃动);    //创建一个3D晃动的效果 CCShakyTiles3D::create(时间,晃动网格大小,晃动范围,Z轴是 ...
    
			
    2. 
						
  2. 添加EF上下文对象，添加接口、实现类以及无处不在的依赖注入（DI）
			
    添加EF上下文对象,添加接口.实现类以及无处不在的依赖注入(DI) 目录索引 [无私分享:ASP.NET CORE 项目实战]目录索引 简介 上一章,我们介绍了安装和新建控制器.视图,这一章我们来创建 ...
    
			
    3. 
						
  3. Python 模块的一般处理
			
    因为Python模块在被导入时,定义在模块中的顶级代码是会被执行的!如果我们想改变这种运行方向可以这样做: if __name__ == '__main__':#当这个模块作为主程序时__name__ ...
    
			
    4. 
						
  4. php命名空间使用
			
    对于命名空间,官方文档已经说得很详细[查看],我在这里做了一下实践和总结. 命名空间一个最明确的目的就是解决重名问题,PHP中不允许两个函数或者类出现相同的名字,否则会产生一个致命的错误.这种情况下只 ...
    
			
    5. 
						
  5. qutIm编译
			
    官网:http://www.qutim.org/ 原文地址:http://wiki.qutim.org/en/building_from_git 依赖: Qt4-dev 4.7:http://qt-p ...
    
			
    6. 
						
  6. Delphi中TFlowPanel实现滚动条效果
			
    由于TFlowPanel中没有设置滚动条的相关属性.所以我们只好另辟溪径.再加一个tscrollbox来实现. 具体操作如下: 1,先添加一个Tscrollbox,设置其align为alclient. ...
    
			
    7. 
						
  7. [原]容器学习（二）：动手模拟AOP
			
    简单来说,Spring是一个轻量级的控制反转(IOC)和面向切面(AOP)的容器框架.上文已经介绍模拟IoC实现,这篇文章来动手模拟AOP. AOP简述 面向对象强调"一切皆是对象" ...
    
			
    8. 
						
  8. Boost::Thread使用示例 - CG-Animation - 博客频道 - CSDN.NET
			
    Boost::Thread使用示例 - CG-Animation - 博客频道 - CSDN.NET Boost::Thread使用示例 分类: C/C++ 2011-07-06 14:48 5926 ...
    
			
    9. 
						
  9. Android 4.2启动代码分析(一)
			
    Android系统启动过程分析 Android系统的框架架构图如下(来自网上):   Linux内核启动之后----->就到Android的Init进程 ----->进而启动Android ...
    
			
    10. 
						
  10. 一起学习iOS开发专用词汇，每天记3个，助你变大牛
			
    大家做开发最大的问题是什么?英语的问题应该困扰很多的同学的地方,我们提倡科学学习开发中的常用词汇.我们不要求大家有特别好的听.说.写,只要能够记住,能够认识这些常用词汇你以后的开发也将游刃有余.我们的 ...
    
			
    11.