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

 @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. python日志记录-logging模块
			
    1.logging模块日志级别 使用logging模块简单示例: >>>import logging >>>logging.debug("this's a ...
    
			
    2. 
						
  2. Sencha Touch 之 Ext.fly方法的使用
			
    Ext.fly方法是Ext.js 4中的flyweight技术,该技术在浏览器中为使用Ext.fly方法的元素节点开辟一块内存,下一次使用Ext.fly方法的元素节点将占据同一块内存,即覆盖前一次的元 ...
    
			
    3. 
						
  3. 新手笔记-tftp与yum
			
    lspci 查看pci插槽设备 lsusb  查看USB设备 tftp 配置文件 /etc/xinetd.d/tftp tftp 根目录 /var/lib/tftpboot service xinet ...
    
			
    4. 
						
  4. tail -f
			
    http://stackoverflow.com/questions/187587/looking-for-a-windows-equivalent-of-the-unix-tail-command  ...
    
			
    5. 
						
  5. elk之nginx
			
    elk之nginx: ignore_older => 86400,不处理一天以前的文件. zjtest7-frontend:/usr/local/logstash-2.3.4/config# c ...
    
			
    6. 
						
  6. git操作标签
			
    操作标签 如果标签打错了,也可以删除: $ git tag -d v0.1 Deleted tag 'v0.1' (was e078af9) 因为创建的标签都只存储在本地,不会自动推送到远程.所以,打 ...
    
			
    7. 
						
  7. BZOJ 1179 [Apio2009]Atm（强连通分量）
			
    [题目链接] http://www.lydsy.com/JudgeOnline/problem.php?id=1179 [题目大意] 给出一张有向带环点权图,给出一些终点,在路径中同一个点的点权只能累 ...
    
			
    8. 
						
  8. Http静态资源的缓存
			
    最近一段时间一直在研究页面缓存和压缩方面的东西,由于公司服务器使用的是iis6.0,很多性能方面的优化都不支持.所以,就开始尝试着自己写个简单的处理程序. 为了减少服务器带宽的需求,我们要减少客户端与 ...
    
			
    9. 
						
  9. C++赋值运算符、函数调用运算符、下标运算符（“=”、“（）”、“[]”）重载
			
    #include <iostream>#include <assert.h>#include <string.h> using namespace std; cla ...
    
			
    10. 
						
  10. Ultra-QuickSort(归并排序)
			
    Ultra-QuickSort Time Limit: 7000MS   Memory Limit: 65536K Total Submissions: 49267   Accepted: 18035 ...
    
			
    11.