javadoc相关内容

Clojure文档工具的艺术状态

过去一年左右,我在Clojure讨论列表和其他地方看到了关于记录Clojure代码的工具的各种公告。这些范围从全面的文字编程系统,如Marginalia,以及用于创建“Clojure in Small Pieces”(甚至是emacs org-mode)的工具,以及更常规的Javadoc风格的解决方案,如Autodoc和Javadoc本身据报道可以与Clojure一起使用。 google搜索引起了 ..

在哪里可以指定我的javadoc文档字符集?

我用波兰语编写javadoc,我想为我的eclipse生成的javadoc文档定义UTF-8字符集 - 我如何和在哪里可以做? 解决方案 Javadoc有三个相关选项: -encoding 选项表示源文件的编码。这应该是你的源文件实际编码的(和编译器应该使用相同的 -encoding 选项)。您可以使用 \uXXXX 约定对不在此编码字符集中的字符进行编码。 (还有一些人认为你不应该 ..
发布时间:2016-11-19 15:29:40 其他开发

JAutodoc像C ++的插件

我使用Eclipse进行C ++开发,我正在寻找一个类似JAutodoc的插件,它将为我的C ++类自动提供Javadoc文档。 任何人都知道如何获取JAutodoc为我做或者可以推荐一些其他工具? 解决方案 我搜索相同,一个解决方案,我喜欢,但看看这两个项目,我认为与一些调整可以成为一个JAutodoc喜欢的Objective-C https://github.com/bru ..
发布时间:2016-10-23 21:05:06 C/C++开发

类似Javadoc的C ++文档

有没有类似的文档生成系统,如Javadoc,C ++? Javadoc产生不错的输出;这将是巨大的,如果你可以使用像其他语言的东西。 解决方案 有几种工具类似JavaDoc for C ++最流行的工具可能是 ..
发布时间:2016-10-22 17:27:26 Java开发

的Javadoc像C#的XML注释文档

我在找东西把我的C#XML注释保存到文档中。我不喜欢CHM的,也不是MSDN的外表和感觉。我喜欢使用的javadoc。它们很容易浏览,一切都可以访问。是否有一个工具,我可以用在我的代码中的注释转换为类似的外观和感觉的Javadoc一个 是否有东西做的?我试过沙塔和它的各种GUI的,但他们不这样做我想做的。 解决方案 的 Doxygen的也许 ..
发布时间:2016-09-19 13:39:37 C#/.NET

C / C ++头文件的文件

创建用C公共头文件时,你怎么认为的最佳实践++? 如果头文件不包含,短暂的或块状的文档?我见过的一切,从几乎没有文档(依靠一些外部文档)大规格不变的,有效的参数,返回值等我不知道到底是什么我preFER,大文件是好的,因为你已经始终可以访问它从你的编辑器,在另一方面具有非常简短的文档,一个头文件往往可以显示文本的一两页给出的可能是怎样的一类做一个更好的概述一个完整的接口。 比方说,我去 ..
发布时间:2016-08-17 22:48:07 C/C++开发

IntelliJ IDEA的显示Javadoc自动

当我在Netbeans的编码是自动填充的code和显示Javadoc文档。然而,当我使用的IntelliJ IDEA如果我点击 控制 + 空格 我可以看到自动完成,如果我点击 控制 + 问: 我可以看到单独的javadoc 是否有可能看到元素的Javadoc,每当我看到自动完成,或点击 控制 + 空格 是在IntelliJ IDEA的像Netbeans的? 解决方案 设置 | 编辑 | ..
发布时间:2016-07-27 14:21:12 JavaScript

如何引用在Javadoc方法参数?

有引用从方法文档体方法参数的一种方式? 是这样的: / ** *如果{@paramref一个}为空,我们依靠b表示discombobulation。 * * @参数一这是参数之一 * @参数b另一个参数 * / 无效美孚(String的形式,INT B) {...} 解决方案 据我可以告诉阅读的的javadoc的对文档没有这样的功能。 不要使用< code基富< ..
发布时间:2016-05-29 12:06:54 Java开发

如何解析的javadoc?

我在使用Java来读取的javadoc的过程。 我的Java对象的属性, 描述 包名称 方法名称,方法说明 是否有任何现有的API,可以做到这一点? 我怎样才能阅读的javadoc以这样的方式,我可以提取上述属性? 解决方案 借助 javadoc的工具包括用于编写自定义的doclet的API。这些基本上得到的文档片段的解析树,它们产生某种报告的基础上。标准doclet生成HTM ..
发布时间:2016-05-22 22:20:16 Java开发

有没有产生Javadoc文档的公共方法的一个子集的方法吗?例如,通过注释公共方法作为"不属于公共API&QUOT的一部分;

我知道如何生产Javadoc文档的类/接口/包的一个子集。但是,有生产的Javadoc只有公共方法的子集的方法吗? 我想preFER是能够标记方法(Javadoc标记或批注)是属于某个API与否​​是它的一部分。然后有只对指定的方法来设置产生的Javadoc的工具 - 这构成了A​​PI的那些 要的方法公共/私营/包访问之间的选择是不够的,我的项目。公共方法可能属于公共API与否​​,或者它可 ..
发布时间:2016-05-22 20:14:13 Java开发

是否有任何缺点将API code成JAR的类一起?

在Java中,如果打包源$ C ​​$ C(的.java)文件与类(的的.class)最IDE的像Eclipse将显示code中的javadoc注释沿罐完成。 IIRC有一些做像JMock的几个开源项目。 可以说,我已经完全分离我的API code从执行code,让我有类似的myproject-api.jar文件和myproject的-impl.jar中是否有任何理由为什么我不应该把源$在我的 ..
发布时间:2016-05-22 19:40:37 Java开发

我怎样才能建立我的jar文件,这样谁使用这个库的用户将能够看到在Eclipse中的javadoc

我正在为我们的公司内部使用的一个小型图书馆,并已严重记录它。现在,我建设我的罐子下面code: <“,”项目名称=“commonutils”默认值=“编译”BASEDIR => <属性名=“SRC”位置=“SRC”/> <属性名=“构建”位置=“buildDirecotry”/> <目标名称=“编译”> <删 ..
发布时间:2016-05-18 22:01:25 Java开发

javadoc中排除类的一些公共的方法

我要排除的几个类的公共方法被纳入的javadoc。我想克里斯Nokleberg的ExcludeDoclet(sixlegs)。但doclet的是给一个小问题: 如果在类返回清单的其它方法(或任何其他泛型), 而不是被显示在Javadoc的列表,返回类型只是被显示为列表(没有通用的信息) 谁能给一个暗示或者对如何解决这一问题提供了环绕工作? 解决方案 我假设你想从javadoc中排除是 ..
发布时间:2016-05-18 21:45:40 Java开发

我能救评论在我的JAR文件(使用Ant生成)的信息?

当我建立我的项目使用Ant JAR文件,我生成Javadoc同一时间。 但是,当我在一个新的项目中使用这个jar,我看不到在Eclipse(pressing F2)JAR的评论。 于是,我就加上“在位置路径”的javadoc位置的Javadoc文件'我的新项目的性质,这是行不通的,即使Eclipse的告诉我“位置可能是有效的。” 当我在浏览器中打开它,网址是像的file:///文件:/ C: ..
发布时间:2016-05-18 21:44:19 Java开发

蚂蚁/ Maven的:" javadoc的:警告 - 错误获取URL"

我最近成立了我的构建服务器(詹金斯)生成的Javadoc文档生成蚂蚁。但是,无论我做什么,我不能得到它包括链接到外部库。当我尝试使用网上链接,蚂蚁返回: [javadoc中]的javadoc:警告 - 错误获取URL:http://docs.oracle.com/javase/6/docs/api/package-list 当我使用离线链接并引用软件包列表的本地副本,它没有给出警告,但不会 ..
发布时间:2016-05-18 20:39:15 Java开发

如何在Ant的Javadoc任务链接的第三方库

我有一个jar文件的形式使用第三方库的一个项目,我使用Ant构建项目的javadoc。我不能让蚂蚁通过javadoc任务时,链接到的第三方库的javadoc。 下面是Javadoc任务: < javadoc的excludepackagenames =“”访问=“私人”DESTDIR =“的javadoc”作者=“真” 版本=“真”的使用=“真”WINDOWTITLE = ..
发布时间:2016-05-18 20:33:53 Java开发

自定义的Javadoc的index.html页?

我正在运行的javadoc与Ant任务: <目标名称=“的javadoc”描述=“创建的javadoc”> <删除DIR =“的javadoc”/> < MKDIR DIR =“的javadoc”/> < javadoc的DESTDIR =“的javadoc”> <文件集DIR =“的src / mai ..
发布时间:2016-05-18 20:06:29 Java开发