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

 @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. 02-4. BCD解密(10)
			
    BCD数是用一个字节来表达两位十进制的数,每四个比特表示一位.所以如果一个BCD数的十六进制是0x12,它表达的就是十进制的12.但是小明没学过BCD,把所有的BCD数都当作二进制数转换成十进制输出了 ...
    
			
    2. 
						
  2. ELMAH+MVC4+SQLite 错误日志
			
    任何程序我想无论是在调试开发阶段还是上线运营阶段,都能够使人“放心”,不要出什么意外,也不要玩什么心跳:那就需要比较到位和及时的异常与错误日志模块. 本文将简要描述ELMAH.MVC4与SQLite这 ...
    
			
    3. 
						
  3. 你是否决绝平庸，你有勇气来学C/C++吗，有勇气来检验你是否经得起世界五百强的面试
			
       如果你来传智播客学习 你的目标就是要积累工作经验 有机会参加世界五百强的面试 秒杀世界五百强的面试 赢得高薪的offer! C/C++课程大纲 C语言3周21天 完全掌握C语言的本质,成为一名合 ...
    
			
    4. 
						
  4. yum subversion puppet puppet-server
			
    yum -y install ruby ruby-libs ruby-shadow yum -y install puppet puppet-server facter yum -y install  ...
    
			
    5. 
						
  5. HDU 3466 Proud Merchants（01背包）
			
    这道题目看出背包非常easy.主要是处理背包的时候须要依照q-p排序然后进行背包. 这样保证了尽量多的利用空间. Proud Merchants Time Limit: 2000/1000 MS (J ...
    
			
    6. 
						
  6. Codeforces Round #277.5 (Div. 2)-D
			
    题意:求该死的菱形数目.直接枚举两端的点.平均意义每一个点连接20条边,用邻接表暴力计算中间节点数目,那么中间节点任选两个与两端可组成的菱形数目有r*(r-1)/2. 代码: #include< ...
    
			
    7. 
						
  7. 转载  C# 序列化与反序列化意义详解
			
    C# 序列化与反序列化意义详解 总结: ①序列化基本是指把一个对象保存到文件或流中,比如可以把文件序列化以保存到Xml中,或一个磁盘文件中②序列化以某种存储形式使自定义对象持久化: ③将对象从一个地方 ...
    
			
    8. 
						
  8. asp.net textbox keyup事件触发后台的textchange事件
			
    textbox文本框text_change事件,失去焦点才会执行. 通过keyup事件,js控制失去焦点. <asp:TextBox runat="server" ID=&q ...
    
			
    9. 
						
  9. TOJ 1139.Compromise
			
    2015-06-03 问题简述: 大概就是输入两段文本(用小写英文字母表示),分别用#表示一段话的结束输入,输出这两个文本的最长公共子序列. 简单的LCS问题,但是输入的是一段话了,而且公共部分比较是 ...
    
			
    10. 
						
  10. spring 入门篇
			
    spring 入门篇         相对于Hibernate(冬眠),Spring(春天),具有更多的诗意与希望的感觉,是为了解决传统J2EE开发效率过低.开发商之间不统一.没有真正实现“写一次到处 ...
    
			
    11.