求制作java文档的资料及规范.
>>Java技术
>>>>文章内容
求制作java文档的资料及规范.
所属分类：Java
J2SE / 基础类-----------------------------------------在程序的开头，变量的开头，注释都采用如下格式的话，则可以用于生成java&doc.
/**
*
*/
==============================
我现在的问题是有没有详细规范及说明资料,&比如注释的时候@后面可以跟很多关键字，它们各有什么用处?&
----------------------------------------------------------------------帮顶
--------------------------------------------------------http://blog.csdn.net/mywanglu115/archive//52162.aspx
google一下看看
--------------------------------------------------------study
--------------------------------------------------------我觉得最好的办法还是结合SUN的API和JAVA类库的源代码
你可以从源码里面看到他是怎么注释的,因为你可以和API对比着看,知道怎么样注释可以生成什么样的效果.
--------------------------------------------------------2.8&注释和嵌入文档
2.8.1&注释文档
用于提取注释的工具叫作javadoc。它采用了部分来自Java编译器的技术，查找我们置入程序的特殊注释标记。它不仅提取由这些标记指示的信息，也将毗邻注释的类名或方法名提取出来。这样一来，我们就可用最轻的工作量，生成十分专业的程序文档。
javadoc输出的是一个HTML文件，可用自己的Web浏览器查看。该工具允许我们创建和管理单个源文件，并生动生成有用的文档。由于有了jvadoc，所以我们能够用标准的方法创建文档。而且由于它非常方便，所以我们能轻松获得所有Java库的文档。
2.8.2&具体语法
所有javadoc命令都只能出现于“/**”注释中。但和平常一样，注释结束于一个“*/”。主要通过两种方式来使用javadoc：嵌入的HTML，或使用“文档标记”。其中，“文档标记”（Doc&tags）是一些以“@”开头的命令，置于注释行的起始处（但前导的“*”会被忽略）。
有三种类型的注释文档，它们对应于位于注释后面的元素：类、变量或者方法。也就是说，一个类注释正好位于一个类定义之前；变量注释正好位于变量定义之前；而一个方法定义正好位于一个方法定义的前面。如下面这个简单的例子所示：
/**&一个类注释&*/
public&class&docTest&{
/**&一个变量注释&*/
public&int&i;
/**&一个方法注释&*/
public&void&f()&{}
}
注意javadoc只能为public（公共）和protected（受保护）成员处理注释文档。“private”（私有）和“友好”（详见5章）成员的注释会被忽略，我们看不到任何输出（也可以用-private标记包括private成员）。这样做是有道理的，因为只有public和protected成员才可在文件之外使用，这是客户程序员的希望。然而，所有类注释都会包含到输出结果里。
上述代码的输出是一个HTML文件，它与其他Java文档具有相同的标准格式。因此，用户会非常熟悉这种格式，可在您设计的类中方便地“漫游”。设计程序时，请务必考虑输入上述代码，用javadoc处理一下，观看最终HTML文件的效果如何。
2.8.3&嵌入HTML
javadoc将HTML命令传递给最终生成的HTML文档。这便使我们能够充分利用HTML的巨大威力。当然，我们的最终动机是格式化代码，不是为了哗众取宠。下面列出一个例子：
/**
*&&pre&
*&System.out.println(new&Date());
*&&/pre&
*/
亦可象在其他Web文档里那样运用HTML，对普通文本进行格式化，使其更具条理、更加美观：
/**
*&您&em&甚至&/em&可以插入一个列表：
*&&ol&
*&&li&&项目一
*&&li&&项目二
*&&li&&项目三
*&&/ol&
*/
注意在文档注释中，位于一行最开头的星号会被javadoc丢弃。同时丢弃的还有前导空格。javadoc会对所有内容进行格式化，使其与标准的文档外观相符。不要将&h1&或&hr&这样的标题当作嵌入HTML使用，因为javadoc会插入自己的标题，我们给出的标题会与之冲撞。
所有类型的注释文档――类、变量和方法――都支持嵌入HTML。
2.8.4&@see：引用其他类
所有三种类型的注释文档都可包含@see标记，它允许我们引用其他类里的文档。对于这个标记，javadoc会生成相应的HTML，将其直接链接到其他文档。格式如下：
@see&类名
@see&完整类名
@see&完整类名#方法名
每一格式都会在生成的文档里自动加入一个超链接的“See&Also”（参见）条目。注意javadoc不会检查我们指定的超链接，不会验证它们是否有效。
2.8.5&类文档标记
随同嵌入HTML和@see引用，类文档还可以包括用于版本信息以及作者姓名的标记。类文档亦可用于“接口”目的（本书后面会详细解释）。
1.&@version
格式如下：
@version&版本信息
其中，“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记，就会从生成的HTML文档里提取出版本信息。
2.&@author
格式如下：
@author&作者信息
其中，“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javadoc命令行使用了“-author”标记，就会专门从生成的HTML文档里提取出作者信息。
可为一系列作者使用多个这样的标记，但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。
2.8.6&变量文档标记
变量文档只能包括嵌入的HTML以及@see引用。
2.8.7&方法文档标记
除嵌入HTML和@see引用之外，方法还允许使用针对参数、返回值以及违例的文档标记。
1.&@param
格式如下：
@param&参数名&说明
其中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记，就认为前一个说明结束。可使用任意数量的说明，每个参数一个。
2.&@return
格式如下：
@return&说明
其中，“说明”是指返回值的含义。它可延续到后面的行内。
3.&@exception
有关“违例”（Exception）的详细情况，我们会在第9章讲述。简言之，它们是一些特殊的对象，若某个方法失败，就可将它们“扔出”对象。调用一个方法时，尽管只有一个违例对象出现，但一些特殊的方法也许能产生任意数量的、不同类型的违例。所有这些违例都需要说明。所以，违例标记的格式如下：
@exception&完整类名&说明
其中，“完整类名”明确指定了一个违例类的名字，它是在其他某个地方定义好的。而“说明”（同样可以延续到下面的行）告诉我们为什么这种特殊类型的违例会在方法调用中出现。
4.&@deprecated
这是Java&1.1的新特性。该标记用于指出一些旧功能已由改进过的新功能取代。该标记的作用是建议用户不必再使用一种特定的功能，因为未来改版时可能摒弃这一功能。若将一个方法标记为@deprecated，则使用该方法时会收到编译器的警告。
--------------------------------------------------------mark
--------------------------------------------------------注释还可以用于JUNIT，这方面知识很多。
--------------------------------------------------------■■国产&袋*鼠*egg&web服务器正式发布，免费且开源
&&&&在java中间件中大部分人都知道tomcat，一个开源免费的web服务器，不过今天要介绍的是一个国内自主开发的web服务器，它的名字叫“袋*鼠*egg”，同样是开源免费的，但是它所运行的不是JSP脚本语言，而是自己开发的DQM脚本语言，其拥有自己的容器用于执行DQM动态文件，我们称之为DQM容器。DQM很类似与JSP，但是比JSP来的简单，所以如果你会JSP那么只需要稍看DQM就会理解。
　　&那么这个服务器有什么特点呢？
　　1、不需要配置XML文件：以前我们&使用J2EE服务器时都时常需要配置XML文件，而&袋*鼠*egg&则不需要，即使使用MVC结构时也是用动态页面进行逻辑控制。
&&&&2、完善的国际化支持：每个涉及到内容输出或读取的方法都重载了带有字符集的方法，这样就不需要再去编写麻烦的过滤器，只需要简单的提供当前所需要使用的字符集。
　　3、有条件的文件输出：BBS的web程序中经常会遇到这样一种情况，允许用户自行上传文件，而上传后的文件必须满足某些条件才能够被访问（读取、下载），这里所指的某些条件例如只有登录用户才能够访问，或者购买了BBS主题后才能访问等等。类似情况在其它web应用中也有很多，那该如何实现这种功能呢？以前我们都是自己写一个servlet进行有条件的文件输出，可是这样会很麻烦，如果要支持断点续传的需要那么自己还要写上一大段程序，要完全符合HTTP协议进行文件输出那么就更加困难了，而在&袋*鼠*egg&只需要简单的使用内置方法即可。
　　4、command内置对象：&袋*鼠*egg&有一个全新的内置对象command，用户可以通过此对象来查看或修改服务器当前信息，利用此对象还可以在不停服务器的情况修改服务器的某些设置，比如不中断服务的情况下软重启服务器。
　　5、生成静态页面：通&有些情况下，动态页面执行后的内容会长时间不变，但是访问的人却很多，如果生成静态页面那么就可以免去了执行动态文件和读取数据库的开销。&袋*鼠*egg&内置了自动的生成静态页面的功能，只需要简单编程就可以自动生成静态页面了。
　　5、编译及隐藏源代码：&袋*鼠*egg&可以关闭自动编译功能，只运行编译后的页面，同时提供了编译整个web应用及隐藏动态页面源代码的功能。
&
　　袋*鼠*eggweb服务器的官方网站：http://kweb.go.3322.org
--------------------------------------------------------谢谢了!&看还有没有更全的资料.
--------------------------------------------------------UP
--------------------------------------------------------你因该看看think&in&java
那上面讲解的很清楚
--------------------------------------------------------求文档！求文档！
[问题点数：100分，结帖人xxuu503]
求文档！求文档！
[问题点数：100分，结帖人xxuu503]
不显示删除回复
显示所有回复
显示星级回复
显示得分回复
只显示楼主
相关帖子推荐：
本帖子已过去太久远了，不再提供回复功能。求文档:_百度作业帮
拍照搜题，秒出答案
　　推荐答案 小学四年级语文试卷　　答卷人；　　同学们,转眼间又是一个学期,又到了我们收获的季节了.现在就请打开的智慧的头脑,来采摘这些丰收的果实吧,记住：只要细心,你就是最棒的!　　基础知识　　一、 看拼音,写词语.　　yú chǔn xī shēng gù zhi zāo tà shuài lǐng　　（愚蠢 ）（牺牲 ） （固执） （糟蹋）（率领）　　biān fu gān zàng wān yán pí bèi jiàn kāng　　( 蝙蝠 ) (肝脏 ) (蜿蜒 ) ( 疲惫 ) ( 健康 )　　二、我会找出意思相近的几组对应地写在括号里.　　拮据 梦寐以求 器重 赠予 困难 疑惑不解　　馈赠 日思夜想 看重 闷闷不乐 迷惑不解 愁眉苦脸　　（馈赠）－－（赠予） （迷惑不解）－－（疑惑不解）　　（闷闷不乐）－－（愁眉苦脸） （梦寐以求）－－（日思夜想）　　（困难）－－（拮据） （器重）－－（看重 ）　　三、把下面的成语补充完整,并选择你最喜欢的最少两个写一两句话,赞美一个你心目中的英雄.　　知（己）知（彼）　　所（向）无（敌）　　声（东）击（西）　　四、句子万花筒.　　1、 面对急需帮助的人,我们怎能袖手旁观呢?（改成陈述句）　　答；面对急需帮助的人,我们不能袖手旁观.　　2、礼花绽放.（把句子写具体）　　答；美丽的礼花像花儿一样绽放 .　　2、 湖面很平静.（改成比喻句）　　答；湖面像镜子一样平静　　4、树叶在哗啦啦地响.（改成拟人句）　　答；树叶在树林中高声唱歌.　　5、纪昌勤学苦练.纪昌成了百发百中的射箭能手.（用上恰当的关联词合成一句话）　　答；纪昌通过勤学苦练,终于成了百发百中的射箭能手.　　阅读题　　（1） _星期天遇事_　　星期天,妈妈带我上街.我特意拿出生日时姑姑送给我的扣花戴在胸前.这扣花可真漂亮,一颗颗晶莹的水晶石镶嵌在金孔雀形的扣花里.动一动,“金孔雀”就闪闪发光,非常惹人喜爱.　　街上(人山人海),商场的人更多.我和妈妈好不容易才挤进柜台.正当我被(五颜六色)的衣料吸引时,肩膀被推了一下.我气得猛一回头,冲着推我的那人嚷道：“挤什么?”没想到那人不但不恼,反而微笑着对我点点头,用手指着我的前胸,嘴里一个劲地“啊,啊……”并招手要我出去.我低头一看“糟糕!我的扣花没了!”　　我不耐烦地挤出人群.只见那人大约三十来岁,个子不高,眯着一双不太有神的眼睛.他一见我便迫不及待地将手中的一件东西送到眼前.我接过扣花定睛一看,这难道不是我丢的那枚扣花吗?我气呼呼地问：“你这人怎么随便拿我的扣花?”那人见我发火,嘴里一个劲儿地“ 啊,啊……” 脸上现出焦急的神情.他一会儿指指我手中的扣花,一会儿又弯腰走几步,做出捡东西的样子,好像要告诉我什么.看他的表情和动作,我明白了他是个聋哑人,是他拾到了我被挤掉的扣花,并交还给我,可我竟……　　“芳芳,你怎么站着发呆?”妈妈的声音打断了我的思绪,我忙（四下环顾）,人呢?我还没有感谢他呢,他却不见了.　　我随妈妈走出商场,一边走一边找那个人,希望看到那双不太有神的眼睛.多么可敬的聋哑人啊!那(拾金不昧)的高贵品质深深打动了我的心.然而我没有找见他,只有我手中被汗水浸湿的扣花在阳光照射下熠熠闪光,显得更加美丽.　　1、给短文加个题目.　　2.把下面的词语准确地填写在文中的( )里.　　人山人海 拾金不昧 五颜六色 四下环顾　　3是他拾到了我被挤掉的扣花,并交还给我,可我竟……”　　①把省略号的意思补充出来：可我竟不管一切的对他乱吼乱叫_____________________　　②这里用省略号表达了“我”；很惭愧____________________________　　4想一想,假如“我”后来又恰恰碰到了那位聋哑人,“我”会怎么说,怎么做呢?请写一段话.我不知怎样感谢你,　　那天我不该横冲直撞的说你,　　请你谅解.　　妙笔生花　　四年的学校生活,你一定经历过不少事情,有愉快的,有不高兴的,有感到委屈的,有……,选择一件你最想告诉别人的事情写下来,做到语句通顺,条理清楚.题目自拟.要选我啊求文档_简随云吧_百度贴吧
&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&签到排名：今日本吧第个签到，本吧因你更精彩，明天继续来努力！
本吧签到人数：0可签7级以上的吧50个
本月漏签0次！成为超级会员，赠送8张补签卡连续签到：天&&累计签到：天超级会员单次开通12个月以上，赠送连续签到卡3张
关注：126贴子：
谁有文档　　　发下给我吧　谢谢啦啊　　邮箱是　　
相关的贴子换一换7796306140714137861536339相关的图贴
可惜只有前十七章。。你要吗
哦。。。。。。。那个&&
貌似网上更新到21章了吧
我前面的现在也看得差不多了
恩，潇湘连载了123章。。免费网站只能看到121章
内&&容:使用签名档&&
保存至快速回贴
为兴趣而生，贴吧更懂你。&或求职文档信息_百度文库
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
文档贡献者
评价文档：
喜欢此文档的还喜欢
求职文档信息
求​职​信​息​文​档
把文档贴到Blog、BBS或个人站等：
普通尺寸(450*500pix)
较大尺寸(630*500pix)
大小：4.13KB
登录百度文库，专享文档复制特权，财富值每天免费拿！
你可能喜欢}