快捷搜索:  as  test  1111  test aNd 8=8  test++aNd+8=8  as++aNd+8=8  as aNd 8=8

新葡棋牌京官网APP:链接span lang=ENUSopopspanBR自定义标记span lang=ENUSopopspanBR设置版本的自动增加span lang=ENUSopopspanBR生成模板span lang=ENUSopopspanBR发布span lang=ENUSJavadocspan到span lang=ENUSGoogel Codespan上span lang=ENUSopopspan



媒介

这一段光阴在钻研Javadoc的问题,前面宣布的Javadoc转换chm赞助文档的四种措施总结,总结了若何实现Javadoc到chm的转换,盼望给大年夜家带来了一些方便,本日我们来说说若何使用Eclipse天生个性化的Javadoc 文档,也盼望大年夜家支持。

天生对象

Eclipse自带的导出为Javadoc功能,不应用cmd下的javadoc敕令。

若何个性

会从说话、编码、链接、自定义标记、设置版本的自动增添(并引申Eclipse下若何设置SVN中的svn:keywords属性)几个方面来个性你的Javadoc文档。

个性分化

说话

若何设置天生的Javadoc默认说话?

办理规划在Eclipse导出Javadoc后面的设置设置设备摆设摆设VM options中加入-locale en_US,然则此时留意的是,假如把-locale en_US设置在后面的话,会报一个差错,大年夜致是-locale en_US 在javadoc敕令必须是在最前面,默认假如不写-locale的话,安装locale说话来进行设置,当然我们中国人便是中文的了。(当然假如你工程默认编码是GBK而且您想天生中文的赞助文档的话,这写都可以不要,应用默认即可)。

编码

Java代码编写的应用有的应用GBK,有的应用UTF-8,这个时刻就会有差别。应用GBK编码的时刻天生Javadoc文档时没有太大年夜问题的,然则,如果全部项目的默认编码款式是UTF-8的话,就会报警告:编码 GBK 的弗成映射字符,根本没有成功天生Javadoc文档,若何办理?办理规划便是在天生Javadoc的时刻对VM options进行编码设置-encoding UTF-8 -charset UTF-8。

(详情请看Javadoc转换chm赞助文档的四种措施总结预处置惩罚部分)

链接

若何使天生的Javadoc在注释的时刻有链接?大年夜家要知道,天生的Javadoc文档默认新葡棋牌京官网APP是html款式的,当然可以应用html标记说话来写一个链接,实际上很简单,看我若何操作。

@author href="http://www.blogjava.net/lishunli/" target="_blank">ShunLi

这样就会天生如下效果

自定义标记

在注释的时刻,Eclipse中有默认的标记,像@author、@version等,都因此@打头,现在我们要天生自己的标记。

查看JDK中Javadoc敕令的赞助文档可以知道(进入cmd敲javadoc –help)

知道必要应用-tag,此中name属性便是你自定义标记的名称,locations官方上有以下解释

Placement of tags - The Xaoptcmf part of the argument determines where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using X). You can supply either a, to allow the tag in all places, or any combination of the新葡棋牌京官网APP other letters:

X (disable tag)

a (all)

o (overview)

p (packages)

t (types, that is classes and interfaces)

c (constructors)

m (methods)

f (fields)

一样平常我小我觉得都应用,选择a,header便是在Javadoc中显示的标题。全部敕令差不多便是这样的:-tag created:a:"Created:"新葡棋牌京官网APP

* 自定义标记

@notes Created on 2010-1-12

这样在天生Javadoc的时刻就不会有报不决义的标记的警告了,然则在天生Javadoc的时刻照样多了一句话:

Note: Custom tags that could override future standard tags:@notes. To avoid potential overrides, use at least one period character (.) in custom tag names.

意思差不多便是你定义的自定义标记有可能会被Sun今后用的,请在定义name的时刻只管即便写个.号,不用管这句话了。

天生的效果:

上面全部在VM Options你们设置的语句如下:

-locale en_US -encoding UTF-8 -charset UTF-8 -tag notes:a:"Notes:"

设置版本的自动增添

你在做项目的时刻,是不是想应用一个@version的标记,然则我们也不能写逝世了,不然每次都是@version V1.0什么的,是不是想它能够根据我们改动文件后能够自动增添或者赋值。上网搜了很多,没有一个能实用的,后来照样在官网上找了一点

@version(reference page)

The Java Software convention for the argument to the @version tag is the SCCS string "%I%, %G%", which converts to something like "1.39, 02/2新葡棋牌京官网APP8/97" (mm/dd/yy) when the file is checked out of SCCS.

意思便是我们要应用SCCS(Source Code Control System),它会跟着SCCS的chedked out增长变更,然则自己没有深入地打仗SCCS,查了一些资料就放弃走这条道了。后来想想自己应用了SVN,看能不能借用SVN。网上的资料很多,开始绕了很多弯,不知道搜索什么,后来找到,便是设置一下SVN中的svn:keywords属性。

我一开始在Eclipse中找到了设置属性的地方,然则有问题,请看:

设置单个文件的属性,右键选择项目,下图就有设置属性

属性名:输入svn:新葡棋牌京官网APPkeywords,输入文本属性为Id Revision Date Author(说一下,曩昔的LastChangedDate、LastChangedBy、LastChangedRevision在SVN1.5里面不在应用,SVN1.5今后应用Date、Revision、Author、HeadURL、Id五个svn:keywords属性,请参考SVN BOOK和SVN的版本自行改动书写),下面有个血色的警告:属性不能利用与文件夹(阐明svn:keywords仅能应用在文件上面),不过不要紧选择递归,打上勾就可以了。

这个对已经提交到办事器上面的是没有问题,然则新建的文件就没有上面的属性了,不建议大年夜家应用这种措施,这种措施仅适用于必要对单个文件设置属性。

下面就说一下若何对所有的文件进行设置设置设备摆设摆设,那当然必要对SVN的设置设置设备摆设摆设文件进行设置(不应用TortoiseSVN等办事器设置设置设备摆设摆设)。

若何的找到svn的config设置设置设备摆设摆设文件?

网上有高手先容如下:

对付Windows xp用户,每个用户的config文件一样平常都能在如下路径中找到:

C:\Documents and Settings\\Application Data\Subversion\config

免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。

您可能还会对下面的文章感兴趣: