翻译一下

该如何写文件意见 对于 JavadocTM 工具 Javadoc 首页 这一份文件描述我们为在文件中的爪哇使用意见在爪哇软件，升阳公司被写的计画风格引导者，标签和图像大会。 资讯科技不重新雕刻被复盖其他地方的相关材料: 作为叁考在 JavadocTM 上的材料标签,见 Javadoc 叁考页。 因为文件意见的必需与语意有关内容,为写爪哇美国石油协会规格见到需求。 内容 介绍 原则 用辞 来源文件 写作文件意见 一个文件意见的格式 文件意见检查工具 描述 一个风格引导者 标签大会 (@标签) 证明疏怠职责建设者 http:// java.sun.com/j2se/javadoc/writingdoccom/index.html# throwstag 包裹- 水平的意见 证明作者不详的内部班级 包括图像 文件意见的例子 修理卷曲的引证 (微软字) -------------------------------------------------------------------------------- 介绍 原则 在爪哇软件，我们举行可能超过第三者开发者的使我们的文件批评不同的一些指导方针。 我们的文件意见定义官方的爪哇月台美国石油协会规格。 对这一个结束，我们的目标听众是那些写爪哇兼容性测试, 或使一致或者再实现爪哇月台的人,除了开发者之外。我们花费时间，而且努力把重心集中在叙述边界情况，争论范围而且迫至一隅情形不愿定义通常的规画期限,写概念上的概观, 而且为开发者包括例子。 因此，那里普遍二个不同的方法写文件意见 -- 如美国石油协会规格, 或如规画指导文件。 这二个目标在下列的区段中被描述。 由于有雅量的资源一个职员能负担混合两者进相同的文件之内;(适当地大块) 然而，我们的优先听写我们给主要的焦点到写文件意见的美国石油协会规格。 这是开发者为什么时常需要转向其他的文件, 像是规画引导者的 J2SE 文件，爪哇个别指导或爪哇班级图书馆 ( 在硬皮的唯一) 。 写作美国石油协会规格 理想地，爪哇美国石油协会规格包含必需做爪哇月台的干净- 房间落实的所有断言为 " 写曾经,无论何处跑"-- 以致于任何的爪哇支程序或申请将会跑在任何的落实上的一样。 这在任何的建筑和功能的规格 ( 通常在 FrameMaker 写) 或任何其他的文件中加上那些可能在文件意见中包括断言。 这一种定义是一个高的目标并且有一些实际的限制到我们能叙述美国石油协会地多完全。 下列各项正在指导我们试着跟随的原则: 爪哇月台美国石油协会规格被文件定义原始码的意见，而且任何的文件从那些意见作记号如可到达的规格。 注意规格不需要完全地被包含在文件意见。尤其，冗长的规格有时最好的在一个分开的文件中格式而且联编到从一个文件意见。 爪哇月台美国石油协会规格是在来电者和落实之间的一份契约。 规格描述所有一位来电者能信赖的每个方法的行为方面。 资讯科技不描述落实细节, 像是方法是否是本国的或同步化。 规格应该描述 (本文地) 由一个给定的物体提供的线- 安全的保证。 缺乏对相反又所有的物体明白的指示被假定是 "线-保险箱".(也就是, 多样的线存取他们是可允许的协同地) 资讯科技是公开的现在规格没有总是活的在到这理想上面。 除非以别的方式着名, 爪哇美国石油协会规格断言需要是落实-中立派。 例外一定分别地而且显着地被设定显着的同样地。 我们对于该如何显着地证明落实不同有指导方针。 爪哇美国石油协会规格应该包含充份使软件质量保证能够写完全的爪哇兼容性装备 (JCK) 测试的断言。 这意谓文件意见一定使 SQA 的顺应需要测试满意。 意见不应该证明疯狂的或现在超出投机的落实如何碰巧工作。 写作规画引导者文件 来自一个规画引导者的分开美国石油协会规格是例子，疯狂的落实通常规画期限，特定的概念上的概观 (像是隐喻) 和描述的定义和工作区。 没有争论这些更快成为开发者的理解因素而且帮助一个开发者写可靠的申请。 然而，因为这些不包含美国石油协会 " 断言 ",他们在一件美国石油协会规格中不是必需的。你能包括文件意见的任何或所有的这数据。 ( 而且能包括订制的标签, 被订制的 doclet 处理, 促进它)在爪哇软件，我们有意识地不包括文件意见的这水平的文件, 而且改为也包括对这数据 (对爪哇个别指导和变化的目录联编) 的联编或包括相同的文件这数据下载如美国石油协会投机的捆 -- JDK 文件捆包括美国石油协会详细说明书和民众，例子和规画引导者。 资讯科技是有用讨论较远的细节有关该如何证明的事疯狂的和工作区。 有时有一个相差在密码应该如何工作之间而且它如何实际上工作。 这能轮流二种不同的表格: 疯狂的疯狂并且编码的美国石油协会投机。 资讯科技是有用在前面上面决定是否你想要证明文件意见的这些。 在我们已经决定在文件意见的外面证明这两个的爪哇软件，虽然我们确实发动例外。 疯狂的美国石油协会投机是疯狂的那在方法公告或影响语法或语意学的文件意见中在场。 当零被获准进入的时候，一个一个如此投机虫的例子是一个被指定丢 NullPointerException 的方法，但是零实际上是一个应该被接受的有用叁数。 ( 而且那样甚至被实现) 如果决定被作出改正美国石油协会规格, 说会是有用的或在美国石油协会规格本身中, 或在一连串的变化中到投机, 或两者的。 证明一种像一个文件意见的这美国石油协会不同，连同它的工作区一起，对他们是最有可能见到它的变化提醒一个开发者。 注意由于这一个订正的一件美国石油协会规格会仍然维持它的落实-独立。 疯狂的密码在落实方面是疯狂的不愿在美国石油协会规格中。 疯狂的密码和他们的工作区时常同样地被在一项虫报告中分开的分配。 然而，如果 Javadoc 工具是用来为特别的落实产生文件,包括文件意见的这数据会是相当有用, 合适地分开如一个笔记或被一个订制的标签.( 发言权 @虫) 世界卫生组织 " 拥有 " 文件意见 -作家或程序师 在爪哇软件，文件意见不是被作家或程序师独家地拥有的，但是他们的所有权在他们之间被分享。资讯科技是基本的前提作家和程序师尊敬彼此能力，而且两者成为最好的文件因素批评可能的。 时常它是一个谈判的物质决定谁写文件的哪一部份,被基于的知识，时间，资源，兴趣，美国石油协会复杂, 和在落实本身的状态上。 理想地，设计美国石油协会的人会写概略的来源文件的美国石油协会规格,藉由唯一的公告和文件意见，在落实方面不料竟会填充使书面的美国石油协会契约满意。 美国石油协会作家的目的是减轻来自一些工作的设计者。 在这情况，美国石油协会设计者会写开始的文件使用稀疏的语言意见,然后作家会检讨意见,精炼内容, 而且增加标签。 如果文件意见是再 implementors 的一件美国石油协会规格, 而且不只是针对开发者的导引,他们应该也被设计，而且实现了美国石油协会的程序师写, 或藉着是或已经成为一个服从的物质专家的一位美国石油协会作家。 如果落实被写到投机但是文件意见是未完成的,一位作家能藉由检查原始码或写测试美国石油协会的计画完成文件意见。一位作家可能为被丢的例外检查或测试,叁数边界为条件, 和为对无效力的争论接受度。然而，如果落实然后不被写到规格一位作家，一种较加困难的情形发生能着手进行写一件美国石油协会规格只有当如果他们也对设计者以他们的问题知道设计者 ( 也经过设计会议或完成的一分开的-书面的设计规格) 的意图或让现金存取。 因此，它可能让一位作家是更困难的为接口和摘要没有 implementors 的班级写文件。 藉由思想的那，这些指导方针预计描述完成的文件意见。 他们被想要当提议并非需求奴隶地被跟随如果他们似乎过度累赘, 或有创造力的替代选择能被发现。 当一个复杂的系统 , 像是爪哇 ( 包含大约 60个包裹) 正在被发展的时候,时常成为一特别组的包裹, 像是 javax.swing 的因素一群工程师可能发展不同于其他的团体指导方针。 这可能是由于那些包裹的不一致需求, 或因为资源拘束。 用辞 美国石油协会文件 (美国石油协会文件) 或美国石油协会规格 (美国石油协会详细说明书) 在线的或美国石油协会的 hardcopy 描述,主要地在爪哇为程序师想要写作。 这些能被产生使用 Javadoc 工具或者产生了一些其他的方法。 一件美国石油协会规格是一份特别类型的美国石油协会文件, 如同在上面描述。 美国石油协会规格的一个例子是在线的爪哇 2 月台, 标准版本美国石油协会规格。 美国石油协会文件的一个例子是 Chan/李的爪哇班级图书馆书。 文件意见 ( 文件意见) 被那 /* 界定的爪哇原始码的特别意见*.。。 */去限器。 这些意见被 Javadoc 处理工具产生美国石油协会文件。 javadoc 产生来自文件意见的美国石油协会文件的 JDK 工具。 来源文件 Javadoc 工具能产生输出起于 " 来源 " 文件的四不同类型: 为爪哇的原始码文件分类 (.新型的计算机语言)- 这些包含班级，接口，领域，建设者和方法意见。 包裹意见文件 - 这些包含包裹意见 概观意见文件 - 这些包含关于包裹的组意见 各种的不加工的文件 -这些包括图像，样品原始码，班级文件，支程序,HTML 申请, 和任何的否则你可能对来自早先的文件叁考想要。 对于较多的细节,见到: 来源文件。 -------------------------------------------------------------------------------- 写作文件意见 一个文件意见的格式 一个文件意见在 HTML 被写而且一定在班级，领域 , 建设者或方法公告之前。 资讯科技由二个部份组成 -- 被区段标签跟随的描述。 在这一个例子中，区段标签是 @param,@回返, 和 @见到。 例子 /** *归还一个然后能在荧屏上被画的图像物体。 *url 争论一定叙述绝对的 http:// java.sun.com/j2se/javadoc/writingdoccom/index.html#{@联编}. 名字 * 争论是一叙述那相对于 url 争论。 *

*这一个方法总是立刻归还, 是否那 *图像存在。 当这一个支程序尝试画那条线图像的时候在 *荧屏,数据将会被装载。 图形原始人 * 那平局图像将会逐渐增加地在荧屏上油漆。 * *@ param url 一个绝对的网址给图像的恶劣位置 * 命名图像的位置,相对于 url 争论 *@回返 在指定的网址图像 *@见到 图像 */ 公众的图像 getImage{(网址 url, 线名字) 尝试 { 归还 getImage(新的网址 (url,名字)); } 捕捉 (MalformedURLException e){ 无效力的回返; } } 注意: 来自流动的 Javadoc 的产生 HTML 在下面被显示 每条线上方被切割成锯齿状在意见下面使密码一致。 第一条行包含开始- 意见的去限器。 (/**) 以 Javadoc 1.4 开始, 领导的星号是可选择的。 写如方法的一个短摘要的第一个句子, 如同 Javadoc 自动地把它放在方法摘要桌子一样.( 和索引) 注意线内标签 {@联编网址}, 转换到一个 HTML 超链接指向文件因为网址分类。 这线内标签能被用任何地方一个意见能被写, 如此的当做在本文中在区段标签之后。 如果你有文件意见的超过一个段落,用一个

段落标签区隔段落,当做显示。 插入在描述和标签的目录之间的一个空白的意见线,当做显示。 第一条由行开始的一 "@" 个性结束描述。 只有每文件意见一个描述区段; 你在区段标签之后不能够继续描述。 最后一条行不像开始- 意见的去限器包含结束- 意见的去限器 (*/) 笔记那,结束-意见只包含一个单一星号。 对于较多的例子,见简单的例子。 因此线将不包装,任何的文件界限- 意见对 80个个性的线。 早先的例子所会在跑 Javadoc 工具之后看起来像的在这里: getImage 公众的图像 getImage(网址 url, 线名字) 归还一个然后能在荧屏上被画的图像物体。 url 争论一定叙述一个绝对的网址。 名字争论是一叙述那相对于 url 争论。 这一个方法总是立刻归还,是否图像存在。 当这一个支程序尝试画那条线在荧屏上的图像时候,数据将会被装载。 图形原始人画那条线图像将会逐渐增加地在荧屏上油漆。 叁数: url- 一个绝对的网址给图像的恶劣位置 命名 -图像的位置, 相对于 url 争论 回返: 在指定的网址图像 也见到: 图像 也在这一份文件结束的时候见到修理卷曲的引证 (微软字) 。 文件意见检查工具 在太阳，我们已经为检查文件意见发展一个工具,呼叫了太阳文件检查 Doclet, 或 DocCheck。 你在原始码上跑它，而且它产生报告描述风格和标签错误意见有, 而且推荐变化。 我们已经尝试使它的规则使一致到这一份文件的规则。 DocCheck 是 Javadoc doclet, 或 " 插件 ", 而且如此需要 Javadoc 工具被安装。 ( 如爪哇 2 的部份标准的版本 SDK) 描述 第一个句子 每个文件意见的第一个句子应该是一个摘要的句子,包含美国石油协会项目的简洁但是完全描述。 这意谓每个成员，班级，接口或包裹描述的第一个句子。Javadoc 工具对适当的成员复印这个第一的句子,分类/ 接口或包装摘要。 这使写脆的和情报的开始能靠他们自己站的句子是重要的。 这一个句子在被一个空格，定位键或线终结者跟随的第一个时期结束, 或在第一个标签.(当做在下面定义) 举例来说，这一个第一个句子在 " 教授 " 结束。: /** *这是一个教授的模拟。 Knuth';s 的混合计算机。 */ 然而，你藉由打字 HTML meta 能在附近工作这- 个性如此的当做 "&" 或 "<" 在时期之后立刻, 如此的当做: /** *这是一个教授的模拟。 Knuth';s 的混合计算机。 */ 或 /** *这是一个教授的模拟。Knuth';s 的混合计算机。 */ 尤其, 写区别的摘要句子超载了来自彼此的方法。 举例来说: /** * 班级建设者。 */ foo{() 。。。 /** *分类叙述物体的数字产生的建设者。 */ foo(int n){ 。。。 落实-独立 写描述给是落实-中立派, 但是叙述如此的属国哪里必需的。 这帮助工程师写密码给是 " 写曾经,无论何处跑". 如很多如可能的,写如一件落实- 独立的美国石油协会规格的文件意见。 清楚地定义是必需的东西和什么被允许改变横过月台/落实。 理想地,为使一致 implementors 使它成为完全的充足。 实际地, 包括充足的描述以便读原始码的某人能写一组顺应测试的实质上随员。 基本上，投机应该是完全的,包括边界情况,叁数范围和角落情形。 哪里适当的, 提到什么被不指定或者允许在落实之中改变的规格树叶。 如果你一定证明落实- 特性的行为, 请在和一个使它清楚它的天线引入线片语的一个分开的段落中证明它是落实-特性。 如果落实依照月台改变,然后在段落的开始 " 在 <月台> 上 " 叙述。 在可能因在一个月台上的落实而改变的其他情形中你可能使用天线引入线片语 "落实-特性:". java.lang.Runtime 的规格落实- 依赖部份的一个例子在这里: 在窗口系统上，窗口美国石油协会的 LoadLibrary 程序 loadLibrary 方法的路径搜寻行为和那相同。 " 在窗口上 " 的使用在句子的开始使它成为清楚的向上前面这是一个落实笔记。 自动机械再方法意见使用 你能藉由知道再避免打字文件意见工具复制 (继承) 的 Javadoc 如何为弃绝或实现其他的方法方法批评。 这在三情况发生: 当在一个班级中的一个方法弃绝一个总纲的一个方法的时候 当在一个接口中的一个方法弃绝 superinterface 的一个方法的时候 当在一个班级中的一个方法实现一个接口的一个方法的时候 在最初二个情形中，如果方法 m() 弃绝另外的一个方法,Javadoc 工具为 m() 将会在文件中产生一个副标题 " 弃绝 ",藉由对它正在弃绝的方法一个联编。 在第三个情形中，如果在一个给定的班级中的方法 m() 实现一个接口的一个方法, Javadoc 工具将会产生一个副标题 " 指定被" 在文件中为 m(),藉由对它正在实现的方法一个联编。 在这些情形中的所有三个中，如果方法 m() 没包含文件意见或标签,Javadoc 工具也将会复印它正在为 m 弃绝或实现到被产生的文件方法的本文。 () 所以如果文件那蹂躏或实现方法是充份的,你不需要为 m 增加文件。 () 如果你把任何的文件意见或标签加入 m()," 弃绝 " 或 "指定被" 副标题和联编将会仍然出现，但是没有本文将会被复印。 一个风格引导者 下列各项是写文件意见的描述有用的顶端和大会。 使用 <密码>为牛鼻子字和名字设计。 牛鼻子字和名字被弥补被 <密码>.。。 当在描述方面提到。 这包括: 爪哇牛鼻子字 包裹名字 班级名字 方法名字 接口名字 领域名字 争论名字 密码例子 使用在-线节俭地联编 你被鼓励增加和美国石油协会的连结名字 ( 列出的立刻在)上面使用那 {@联编}标签。 资讯科技不必需的增加一个文件意见的和所有的美国石油协会名字的连结。 因为联编注意他们自己 ( 藉着他们的颜色而且在 HTML 中下面划线, 和藉着原始码文件的他们长度意见),如果很多地用，它能使意见变成更困难读。 我们因此推荐把一个联编加入一个美国石油协会名字如果: 使用者可能实际上想要对于较多的数据 (在你的裁判中) 在它上按, 和 只对于文件的每个美国石油协会名字的第一发生批评 (不烦扰重复一个联编) 我们的听众被前进 ( 不新手) 程序师，因此，联编到 java.lang 包裹 (像是线) 的美国石油协会是通常不是必需, 或你感觉的其他美国石油协会会是众所周知的。 为一般形式的方法和建设者省略刮弧 当提及一个方法或有多样的表格建设者的时候，而且你意谓提及一种特定的形式,使用刮弧和争论类型。 举例来说， ArrayList 有二增加方法: 增加 (物体) 了又增加 (物体) 。 (int,物体) 那增加 (int,物体) 方法把一个项目在一个指定的位置加入这 arraylist。 然而, 如果谈及到两者形式的方法,全部省略刮弧。 因为那会暗示，所以资讯科技正在误导包括空的刮弧一特别形式的方法。 专心的这里是区别来自它的特别表格之中的任何一个的一般方法。 包括”方法”那个字区别它如一个方法和不是一个领域。 那增加方法准许你插入项目。 (偏爱) 那增加 () 方法使你能够插入项目。 ( 避免当你低劣 " 所有的表格 " 那增加方法) 好使用片语代替完全的句子,在短暂的兴趣中。 这尤其在开始的摘要中支撑和在 @param 标签描述。 使用第三个人 (描述的) 不第二个人。 (规约的) 描述是在第三个人中能明白的不愿第二个人命令。 拿标签。 (偏爱) 拿标签。 (避免) 方法描述由一个动词片语开始。 一个方法实现操作，因此，它通常从一个动词片语开始: 拿这一个钮扣的标签。 (偏爱) 这一个方法拿这一个钮扣的标签。 (避免) 班级/ 接口/ 领域描述能省略主题并且只是说物体。 这些美国石油协会时常描述事物并非行动或行为: 钮扣标签。 (偏爱) 这一个领域是钮扣标签。 (避免) 使用 " 这 " 代替 " 那 " 当提及一个物体从现在的班级产生的时候。 举例来说， getToolkit 方法的描述应该依下列各项读: 为这一个成份拿工具箱。 (偏爱) 为成份拿工具箱。 (避免) 增加描述超过美国石油协会名字。 最好的美国石油协会名字是 " 自我证明的 ",意谓他们基本上告诉你美国石油协会做的。 如果文件意见只以句子形式重复美国石油协会名字,它没有在提供较多的数据。 举例来说，如果方法描述只使用在方法名字中出现的字,然后它正在把无全然加入你可以推论出的。 理想的意见超越那些字而且应该总是用一些一点点的从美国石油协会名字不是立刻明显的数据奖赏你。 避免 - 描述在发言权无下面超过你从读方法名字知道的。 ”组”那个字," 工具 " ， " 顶端 " 和 " 本文 " 只是在一个句子中被重复。 /** *设定工具顶端本文。 * *@ param 本文工具的本文装顶端 */ 民众空虚 setToolTipText{(串起本文) 优先的 -这描述更完全定义工具顶端是什么, 在登记而且被显示的较大上下文中回应光标。 /** *登记本文在工具顶端中显示。 本文 * 展览当光标在成份之上逗留的时候。 * *@ param 本文线显示。 如果本文是无效力的, * 工具顶端被为这一个成份关掉。 */ 民众空虚 setToolTipText{(串起本文) 当使用期限 " 领域 " 的时候，要清楚。 要知道那一个”领域”那个字有二意义: 静态的领域, 是对于 "班级变数" 另外的一个期限 本文领域, 当做在 TextField 班级中。 注意这种领域可能被限制到握住日期，数字或任何的本文。 交互的名字可能是 " 约会领域 " 或 " 数领域 ", 当做充用。 避免拉丁文 -- 使用 " 也知道当做"代替 " aka", 使用 " 那是 " 或 " 是特定的"代替 " 也就是 ",使用 " 举例来说 " 代替 " 举例来说 ", 而且使用 " 换句话说 " 或 " 即 " 代替 " viz". 标签大会 大部份的下列标签被以爪哇语言规格，第一个版本指定。 也见到 Javadoc 叁考页。 标签的次序 包括下列的次序标签: *@作家 ( 班级和接口只有,需要) *@版本 ( 班级和接口只有,必需的)(见到脚注 1) *@param (只有方法和建设者) *@回返 (只有方法) *@例外 (@投是一个在 Javadoc 1.2 中被增加的同义字) *@见到 *@自从～后 *@序列 ( 或 @ serialField 或 @serialData) *@ 声明不赞成 ( 见到该如何以及何时声明不赞成美国石油协会) 命令多样的标签 当一个标签出现一个文件意见的超过一次的时候，我们雇用下列的大会。如果需要, 群体的标签, 像是复 @见到标签, 能与另一个分离藉着和一个单一星号的一条空白的线附以签条。 多样的 @ 作家标签应该在按年代序的次序中被列出,与班级的创作者在顶端列出。 多样的 @param 标签应该在争论- 公告的次序中被列出。 这使视觉上相配目录给公告是比较容易的。 多样的 @ 丢标签 ( 也已知的当做 @例外) 应该按字母顺序地被例外名字列出。 多样的 @ 见到标签应该依下列各项被命令, 概略地是如同他们的争论一般的次序被 javadoc 寻找, 基本上从最近的对最远的通路,从最少- 取得资格到完全-合格的,下列的目录表示这前进。注意方法和建设者是在压缩次序方面,这首先意谓没有 arg 形式,然后 "1 arg" 形成,然后 "2 arg" 形成, 和如此往前。 在分类钥匙的秒被需要的地方, 他们可能被列出不是按字母顺序地就是合乎逻辑地聚集。 @ 见到 #领域 @ 见到 #建设者(类型,类型。。.) @ 见到 #建设者(类型遗传素质, 类型遗传素质。。.) @ 见到 #方法(类型，类型,.。.) @ 见到 #方法(类型遗传素质，类型，遗传素质。。.) @见到班级 @见到班级#领域 @见到班级#建设者(类型,类型。。.) @见到班级#建设者 (类型遗传素质, 类型遗传素质) @见到班级#方法(类型，类型,.。.) @见到班级#方法(类型遗传素质, 类型遗传素质,.。.) @见到包裹班级。 @见到 package.Class#领域 @见到 package.Class#建设者(类型,类型。。.) @见到 package.Class#建设者 (类型遗传素质, 类型遗传素质) @见到 package.Class#方法(类型，类型,.。.) @见到 package.Class#方法 (类型遗传素质，类型,遗传素质) @见到包裹 必需的标签 一 @param 标签为每个叁数被需要, 即使当描述是明显的。那 @ 回返标签为除了空虚之外归还某事的每个方法被需要,即使它对方法描述感到多余。 ( 每当可能的, 找非东西多余的 (理想地,较多的特性) 为标签使用批评.) 这些原则加快自动化搜寻而且自动化处理。 时常,也, 努力在额外的清楚中走开避免多余薪资。 标签意见 如一个提醒的人，这些标签的基本使用在 Javadoc 叁考页上被描述。 爪哇软件通常使用那跟随另外的指导方针为每个标签产生意见: @作家 ( 叁考页) 你能提供一 @ 作家标签, 多样的 @ 作家标签, 或不 @ 作家标签。 当新美国石油协会的发展是一个开着又联合的努力时候，在社区的这些数天中处理, JSR 能是在包裹水平为新的包裹考虑作家。 举例来说，新的包裹 java.nio 有 "@ 作家 JSR-51 专家团体"在包裹水平。 然后个别的程序师能被指定给 @在班级水平的作家。 就如这一个标签才能在概观，包裹被应用而且分类水平的,标签只适用于那些制造对设计或落实的重要贡献的人, 而且不通常包括技术上的作家。 那 @ 作家因为当产生美国石油协会规格的时候，它不被包括，所以标签不是紧要关头的，而且因此它只被正在看原始码的那些见到。 (版本历史也能为内在的目的作为决定贡献者)。 如果某人强烈地感觉他们需要增加 @ 作家在成员水平，他们可以藉由跑 javadoc 这么做使用新的 1.4个标签的选项: -标签作家:一:"着作:" 如果作家是未知的, 使用不归于如争论到 @作家。 也见到 http:// java.sun.com/j2se/javadoc/writingdoccom/index.html#multiple@author。 @版本 ( 叁考页) 为争论的爪哇软件大会到那 @ 版本标签是 SCCS 线 "%我%,%G%", 转换到某事相似的 "1.39,02/28/97"(毫米/dd/yy)当文件被检查离 SCCS 的时候。 @param ( 叁考页) 那 @param 标签被叁数的名字 ( 不数据类型) 跟随,被叁数的描述跟随。 藉着大会，描述的第一个名词是叁数的数据类型。 ( 文章喜欢 " 一 "," 一 ", 和 " 那 " 能在名词之前.) 例外被对原始的 int 有益,在数据类型通常被省略的地方。 另外的空间能在名字和描述之间被插入，以便描述排成一行在一个区段中上面。冲撞或其他的标点在描述之前不应该被插入,如 Javadoc 工具插入冲撞。 叁数名字是大会的小写字母。 数据类型从一个小写字母开始指出一个物体并非一个班级。 如果它是一个句子，如果它是一个片语 (没包含动词), 或一封大写字母的信，描述由一个小写字母开始。 只有当如果另外的一个片语或句子跟随它，用一个时期结束片语。 例子: *@param ch 个性被测试 *@ param 观察者图像观察者被通知 不支架叁数的名字在那之后 @ param 标签由于 <编码>.。。 因为 Javadoc 1.2 而且稍后自动地做这。 (由 1.4 开始,名字不能够包含任何的 HTML, 如同 Javadoc 比较那 @ param 名字和一样在签字中出现的名字而且发出一个警告如果有任何的不同.) 当写意见他们自己，大体上，从一个片语开始而且用句子跟随它的时候如果他们被需要。 当写一个片语的时候,不以大写字母写而且不以一个时期结束: @ param x x- 同等的人物, 在图素中测量 当写一个片语藉着一个句子跟随,不以大写字母写片语, 但是用一个时期结束它区别它和下一个句子的开始时候: @ param x x-同等的人物。 在图素中测量。 如果你用一个句子偏爱出发, 以大写字母写它而且用一个时期结束它: @param x 叙述 x-同等的人物,在图素中测量。 当写多样的句子时候,遵从常态句子规则: @param x 叙述 x-同等的人物。 在图素中测量。 也见到 http:// java.sun.com/j2se/javadoc/writingdoccom/index.html#multiple@param。 @回返 ( 叁考页) 省略 @ 回返对于归还空虚的方法和对于建设者; 为所有的其他方法包括它,即使它的内容对方法描述感到完全地多余。 有一明白的 @ 回返标签使它变成更容易让某人很快地找回返价值。 每当可能的, 对于特别的情形补给回返价值.( 如此的当做叙述被退还的价值当一个外面-- 范围的争论被供应的时候) @声明不赞成 ( 叁考页) 那 @ 声明不赞成第一个句子的描述应该至少告诉使用者当美国石油协会被声明不赞成的时候和该使用如一个替换什么。 只有第一个句子将会在摘要的区段和索引中出现。 后来的句子也能解释它为什么已经被声明不赞成。当为一个被声明不赞成的美国石油协会产生描述的时候， Javadoc 工具移动那 @在描述之前声明不赞成本文, 把它放在斜体字和前述的它由于一个大胆的警告: " 声明不赞成 " 。 一 @ 见到标签 (对于 Javadoc 1.1) 或 {@联编}标签 ( 对于 Javadoc 1.2 或稍后) 应该被包括对替换方法的那点: 因为 Javadoc 1.2 而且稍后，标准的格式是使用 @ 声明不赞成了标签和那在- 线 {@联编}标签。 这产生联编在-线,在你想要它的地方。 举例来说: /** *@ 声明不赞成当做 JDK 1.1, 代替被 {@ 联编 #setBounds}(int ， int ， int,int) */ 因为 Javadoc 1.1, 标准的格式是产生一双 @ 声明不赞成和 @见到标签。 举例来说: /** *@ 声明不赞成当做 JDK 1.1, 被 setBounds 代替 *@ 见到 #setBounds(int ， int ， int,int) */ 如果成员没有替换, 争论到 @ 声明不赞成应该是没有替换. 不要增加 @不需要首先和适当的工程师检查就声明不赞成了标签。 实词修正应该同样地被首先检查。 @自从～后 ( 叁考页) 当爪哇名字被增加到美国石油协会规格的时候，叙述产品版本。 ( 如果不同的落实)举例来说，如果包裹，班级 , 接口或成员被增加到爪哇 2 月台，标准的版本,在 1.2 版的美国石油协会规格,使用: /** *@ 自从 1.2 以后 */ Javadoc 标准 doclet 显示一 " 自从～以后 " 如它的本文和线争论的副标题。 这一个副标题只有在地方中的被产生的本文中出现符合到哪里那 @因为标签在来源文件意见中出现。 (Javadoc 工具不把它增殖下来阶级组织) ( 大会一次是 "@ 因为 JDK1.2"但是因为这是爪哇月台的一件规格, 不是特别到太阳 JDK 或 SDK ，我们已经降低 " JDK" )。 当一个包裹被介绍的时候, 叙述一 @ 自从～以后标签在它的包裹描述和它的每一个班级中。( 增加 @ 因为附以签条到每个班级是技术上不需要, 但是我们的大会, 如原始码的准许较棒的能见.) 缺乏弃绝标签, 价值那 @因为标签适用于每一个包裹的班级和成员。 当一个班级 ( 或接口) 被介绍的时候, 叙述一 @ 自从～以后它的班级描述的标签和不 @自从～以后成员的标签。 增加一 @ 因为只对成员附以签条超过班级在一个较迟的版本中增加。 这将数字减到最少 @自从～以后标签。 如果一个成员从保护对较迟的释放民众改变, 那 @因为标签不改变,即使现在它在～手边任何来电者是可使用的, 不只是次分选羊毛等级的工人。 @ 投 (@例外是最初的标签) ( 叁考页) 一 @ 丢标签应该为任何的被检查的例外 (在投子句中宣布) 被包括在内,当做在下面举例, 以及为任何的未加抑制的例外来电者可能适度地想要捕捉,除了 NullPointerException。 当他们是不可预知的时候，错误不应该被证明。 对于较多的细节,请见到 http:// java.sun.com/j2se/javadoc/writingdoccom/index.html#throwstag。 /** *@ 丢 IOException 如果输入或被发生的输出例外 */ 民众空虚 f() 丢 IOException{ //身体 } 见到爪哇语言规格的例外章,对于在例外上的更多秒版。 也见到 http:// java.sun.com/j2se/javadoc/writingdoccom/index.html#multiple@throws。 @见到 ( 叁考页) 也见到 http:// java.sun.com/j2se/javadoc/writingdoccom/index.html#multiple@see。 @ 序列 @ serialField @ serialData (全部在 Javadoc 1.2 中增加) ( 叁考页) 因为关于该如何使用这些标签的资讯，连同一个例子一起，见为一个班级证明 Serializable 领域和数据,爪哇物体连载规格的第 1.6 节。 也见到太阳对包括被写成连载长篇而刊登的形式规格的班级标准。 {@联编}(在 Javadoc 1.2 中增加) ( 叁考页) 对于大会, 见到使用在- 线节俭地的联编。 证明疏怠职责建设者 爪哇语言规格的第 8.8.7 节,秒版描述一个假设值建设者: 如果一个班级没包含建设者公告,然后一个没轮流叁数的假设值建设者自动地被提供。 资讯科技用没有争论唤起总纲建设者。 建设者有如同它的班级一般的通路。 Javadoc 工具为假设值建设者产生文件。 因为一个假设值建设者能没有文件意见，所以当它证明一个如此建设者的时候,Javadoc 留下它的描述空格。 问题然后发生: 你如何为一个假设值建设者增加一个文件意见? 简单的答案是它不是可能的 -- 并且,方便地，我们的规画大会是避免假设值建设者。 (我们考虑但是拒绝主意， Javadoc 工具应该为假设值建设者产生一个假设值意见)。 好规画练习命令那一个密码应该从不利用公众的美国石油协会的假设值建设者: 所有的建设者应该是明白的。那是, 全部当众疏怠职责建设者而且保护班级应该与适当的通路修饰语一起变成明白的建设者公告。 这明白的公告也给你一个地方写文件意见。 理由这是好的规画练习是明白的公告帮助从不注意地避免一个班级被做 instantiable, 如设计工程师必须实际上有关建设者的通路作决定。 我们已经有我们没有想要一个公众的班级是 instantiable 的一些情形，但是程序师俯看了事实它的假设值建设者是公众的。 如果一个班级不注意地被允许是产品的一个被释放的版本 instantiable,向上的兼容性听写无心的建设者在将来的版本中被保有。 在这些不幸的环境之下，建设者应该被做明白并且声明不赞成。 ( 使用 @声明不赞成) 注意，当创造一个明白的建设者的时候，它一定精确地相配自动地产生的建设者的公告; 即使建设者应该合乎逻辑地被保护,它一定被公开相配自动地产生的建设者的公告,为兼容性。 一适当的然后文件意见应该被提供。 时常，意见应该同样地是某事简单的当做: /** * 脚掌建设者。 ( 因为亚纲建设者的祈愿,典型地 *暗示的.) */ 保护了 AbstractMap{() } 用 @证明例外丢标签 注意 - 标签 @ 丢和 @例外是同义字。 证明美国石油协会详细说明书的例外 为方法的美国石油协会规格是在一位来电者和 implementor 之间的一份契约。 Javadoc 产生的美国石油协会文件包含为例外叙述这一份契约的二个方法 -- 公告的 " 投 " 子句, 和那 @丢 Javadoc 标签。 这些指导方针描述该如何证明例外那 @丢标签。 投标签 目的那 @投标签是指出哪一例外程序师一定捕捉 (为检查例外) 或可能想要捕捉。 (对于未加抑制的例外) 指导方针 -证明哪一例外 用那证明下列的例外 @丢标签: 全部检查了例外。 (这些一定在投子句中被宣布)。 来电者可能适度地想要捕捉的那些未加抑制的例外。 (资讯科技是考虑过的贫穷规画练习包括投子句的未加抑制的例外)。 证明这些在那 @ 投标签是决定于美国石油协会设计者的裁判, 如同在下面描述。 证明未加抑制的例外 资讯科技通常令人想要的证明未加抑制的例外一个方法能丢: 这允许 ( 但是不需要) 来电者处理这些例外。 举例来说，它允许来电者 " 翻译 " 落实-对被输出抽象化的来电者的对更适当的一些其他的例外依赖的未加抑制的例外。 因为没有方法保证一个呼叫已经证明所有的未加抑制的例外，它可能丢,程序师不能仰赖推测一个方法不能够丢那些它被证明丢之外的任何未加抑制的例外。 换句话说，你应该总是承担一个方法能丢无证明的未加抑制的例外。 注意它总是不适当证明一个方法丢对那一个方法的现在落实被系的未加抑制的例外。 换句话说,证明与在下面的落实无关的例外。 举例来说，一个轮流一个索引并且使用排列的方法在内部不应该被证明丢 ArrayIndexOutOfBoundsException, 如另外的落实可以除了排列之外使用数据结构在内部。 资讯科技然而,通常适当的证明一个如此方法丢 IndexOutOfBoundsException。 如果你不证明未加抑制的例外，记住,其他的落实是免费不丢那例外。 适当地证明例外是一个重要部份写-曾经,跑-无论何处。 -------------------------------------------------------------------------------- 背景在检查之上和未加抑制的例外 主意在后检查例外是编辑者检查在编译-计时例外在一个尝试- 捕捉的区段中正在适当地被捕捉。 你能识别检查和依下列各项未加抑制的例外。 未加抑制的例外是班级 RuntimeException ，错误和他们的亚纲。 所有的其他例外亚纲被检查例外。 注意，例外是否被检查或未加抑制的那不是被它是否被包含在一个投子句之中定义的。 在投子句上的背景 检查例外一定被包含在方法的一个投子句之中。 这是必需的让编辑者知道检查哪一例外。 举例来说:(在 java.lang.Class 中) 公众的静电班级 forName( 线 className) 丢 ClassNotFoundException 藉着大会，未加抑制的例外不应该被包含在一个投子句之中。 ( 包括他们被考虑是贫穷的规画练习。 编辑者视他们为意见, 而且做在他们上的没有检查)。 下列各项是贫穷的密码 -- 既然例外是 RuntimeException ，它应该被证明在那 @改为丢标签。 java.lang。位元组原始码: 民众静电位元组 valueOf( 线 s,int 基) 丢 NumberformatException 注意爪哇语言规格也表示投子句的未加抑制的例外。 ( 依下列各项) 只在投机中使用投子句作为未加抑制的例外是一个必须指出的装置这例外是在来电者和 implementor 之间的契约部份。 下列各项是这的一例子。 (" 结局 " 和 " 同步 " 被移动使比较变成更简单哪里) java.util。矢量原始码: 公众的物体 elementAt(int 索引) java.util。以爪哇语言规格，第一个 Edmund 无线电诱导投机。 (p。 656): 公众的物体 elementAt(int 索引) 丢 IndexOutOfBoundsException 包裹- 水平的意见 藉由 Javadoc 1.2 ，包裹- 水平的文件意见是可得的。 每个包裹能有它自己的包裹级的文件意见来源文件 Javadoc 工具将会进入它生产的文件之内合并。 这一个文件叫做 package.html 。 ( 而且是所有的包裹相同的名字) 这一个文件向前在来源目录中被保持由于所有的那 *.新型的计算机语言申请。 (不要把 packages.html 文件放入新的文件- 文件的来源目录,因为那些文件只被复印到目的地并且不被处理.) 这里是包裹级的来源一个例子 java.text 和 Javadoc 工具产生的文件文件: package.html-------------->包裹-summary.html ( 来源文件) javadoc (目的地文件) Javadoc 工具藉由做三件事物处理 package.html: 在目的地文件包裹的摘要桌子下面复印它的内容 ( 每件事物在 <身体>之间和 )-summary.html。 任何的程序 @见到,@ 因为或 {@联编} Javadoc 在场的标签。 复印第一个句子到那用右手纵队的概观摘要。 为 package.html 来源文件的型板 当创造意见申请的一个新的包裹文件的时候，在升阳公司，我们使用下列的型板。 这包含一份版权陈述。 明显地，如果你来自一家不同的公司,你会供应你自己的版权陈述。 一个工程师会复印这全部文件,重新命名它到 package.html, 而且划除与年功袖章一起出发的线: #####. 一个如此的文件应该进入来源树的每个包裹目录。 为包裹级的文件意见文件倒空型板 package.html 来源文件的内容 包裹文件意见应该提供 ( 直接地或经由联编) 允许程序师使用包裹所需的每件事物。 资讯科技是一个非常重要文件: 对于许多设备 ( 归一个单一包裹所有的那些人但是不在一个单一班级中) 它是程序师将会去拿文件的第一个地方。资讯科技应该包含设备的短又易读描述是由被对详细的文件 , 或详细的文件本身的指针跟随的包裹 (在介绍方面,在下面) 提供, 无论那一个是适当的。 哪一是适当的将会仰赖包裹: 如果资讯科技是一个较大的系统 ( 如此的当做,37 之一 Corba 的包裹) 的部份, 或一份 Framemaker 文件已经为包裹存在，一个指针是适当的; 如果包裹是自我包含的并且不需要广泛的文件，详细的文件应该被包含在包裹文件意见文件本身。 (像是 java.math) 为了总结，包裹文件意见的主要目的是描述包裹的目的，必需了解并且使用它的概念上的结构和在包含它的班级之中的关系。 为大的, 合成物包装 ( 和是大又复杂美国石油协会的部份那些人) 对一份外部的建筑学文件的一个指针被保证。 当写一个包裹级的意见申请的时候，下列各项是你应该使用的区段和标题。 因为 Javadoc 工具拾起第一个本文如摘要的陈述，所以在第一个句子之前应该有没有朝向。 使第一个句子成为包裹的一个摘要。 举例来说: " 以一个自然语言的样子中立派提供班级和接口给操作的本文，日期，数字和信息 " 。 描述包裹包含的而且说它的目的。 包裹规格 包括描述或对于这一个不被包含在 javadoc 产生的文件其它部分之中的包裹任何的包裹- 宽的规格联编。举例来说， java.awt 包裹可能描述那一个包裹的一般行为如何被允许从一个操作系统人变化到另外一 (窗口， Solaris, Mac) 。 如果他们包含在 javadoc 产生的文件中不出现的断言，包括对在文件的外面被写意见 ( 如此的当做在 FrameMaker 中或任何的) 任何的规格联编。 断言是使一致 implementor 会必须为了要实现爪哇月台 , 知道的一份陈述。 在那一种基础上，在太阳，这一个区段的叁考对爪哇兼容性装备 (JCK) 是紧要关头的。 爪哇兼容性装备包括一个测试查证每断言, 决定被看作是爪哇 CompatibleTM 的东西。 陈述 " 归还 int" 是断言。 一个例子不是断言。 一些 " 规格 " 那设计已经写没包含断言不已经在美国石油协会详细说明书 (javadoc) 中陈述 -- 他们仅仅详述美国石油协会详细说明书。 在这尊敬，一份如此文件应该不在这一个区段中被提到, 但是宁可应该在下一个区段中被提到。 包括特定的叁考。 如果只有叁考的文件一个区段应该被考虑美国石油协会投机的部份,然后你应该在下一个区段中联编或提及只有那一个区段而且提及文件的其它部分。 主意是清楚地描绘是美国石油协会投机的部份东西和什么是不，因此 JCK 队能用适当的宽度写测试。 这可能甚至鼓励一些作家分别地打破文件，如此详细说明书是分开的。 相关的文件 包括关于不包含规格断言, 像是概观，个别指导，例子，民众和引导者的任何文件的参考。 班级和接口摘要 [ 省略这一个区段，直到我们实现 @种类标签] 描述班级的合乎逻辑配列和接口 @ 见到其他的包裹，班级和接口 证明作者不详的内部班级 在作者不详的班级公告作者不详的内部班级以爪哇语言规格，秒版被定义。 Javadoc 工具不直接地证明作者不详的班级 -- 那是,他们的公告和文件意见被忽略。 如果你想要证明一个作者不详的班级,这么做的适当方法是在它的外部班级的一个文件意见 , 或另外的接近联合的班级中。 举例来说，如果你有了归还一个 JTree 物体的方法 makeTree 的作者不详的 TreeSelectionListener 内部的班级，这一个班级的使用者可能想要弃绝,你可以在方法中证明意见被送回的 JTree 附上 TreeSelectionListener 到它: /** *作为创造树的方法。 任何的结构修正 *到 Jtree 的展览应该被藉由弃绝这一个方法做。 *这一个方法把作者不详的 TreeSelectionListener 加入被送回的 JTree 。 * 一收到呼叫生气蓬勃的 TreeSelectionEvents ，这一个收听者 *如一个叁数的挑选节。 */ 公众的 JTree makeTree(AreaInfo ai){ } 包括图像 这一个区段包括被用于文件意见的图像而不是直接地被原始码用的图像。 注意: 对 Javadoc 1.0 和 1.1 版感到必需的子弹和标题图像位于 JDK 的图像目录下载捆: jdk1.1/文件/api/图像/. 那些图像不再是需要的开始由于 1.2. 在～之前 Javadoc 1.2 ， Javadoc 工具不复印对目的地目录的图像 -- 你必须用手也在分开的操作方面做它或由于一个手写体。 Javadoc 1.2 容貌为和目的地目录的副本一个被命名的目录 "文件-申请"在来源树 ( 一对于每个包裹) 和它的内容中。 ( 资讯科技做浅的副本为 1.2 和 1.3, 而且做深的副本为 1.4 和稍后.) 因此，你能进入这一个目录之内放任何的图像 (图形交换格式，联合图象专家组格式,及其他) 或其他的文件不被 Javadoc 工具以别的方式处理。 下列各项是包括文件意见的图像大会的爪哇软件提议。 主人的图像会位于来源树; 当 Javadoc 工具与标准的 doclet 一起跑的时候,它会复印对目的地 HTML 目录的那些文件。 来源树的图像 来源树的文件图像的取名 - 名字图形交换格式图像 <班级>-1. gif,在相同的班级中为后来的图像增量完整的事物。 例子: 钮扣 -1. gif 来源树的文件图像的位置 - 把文件图像放入一个被叫做的目录 "文件-文件". 这一个目录应该归来源文件住的相同包裹目录所有。( 名字 "文件-申请"当文件从被原始码本身, 像是在图形用户接口中被显示的位图用的图像分开，区别它.) 例子: 钮扣，钮扣 -1. gif 的一个萤幕画面, 可能为钮扣被包含在班级之中意见分类。 钮扣来源文件和图像会位于: 新型的计算机语言/awt/ Button.java( 来源文件) 新型的计算机语言/awt/文件- 文件/ 钮扣 -1. gif( 图像文件) 在 HTML 目的地中图像 在 HTML 目的地中文件图像的取名 - 图像会有那相同的名字当他们有在来源树中。 例子: 钮扣 -1. gif 在 HTML 目的地中文件图像的位置 - 藉由阶层的文件输出, 像是 Javadoc 1.2 ，目录会位于被命名的包裹目录 "文件-文件". 举例来说: api/新型的计算机语言/awt/文件-文件/钮扣 -1. gif 藉由平坦的文件输出, 像是 Javadoc 1.1 ，目录会位于包裹目录而且命名 "图像-<包裹>". 举例来说: api/图像-java.awt/ api/图像-java.awt.swing/ 文件意见的例子 /** *图形对于所有的图形上下文是抽象的基础班级 * 允许一个在被了解的成份之上拉的申请在 * 各种不同的装置或在离开- 荧屏的图像之上。 * 一个图形物体装入胶囊州数据需要的 *对于爪哇支援的各种不同的翻译操作。 这 *州数据包括: *

*
• 成份临近 *
• 一翻译起源对于翻译和剪断坐标 *
• 现在的修剪 *
• 现在的颜色 *
• 现在的字型 *
• 现在的合乎逻辑的图素操作功能 (XOR 或油漆) *
• 现在的 XOR 交互颜色 * ( 见到 setXORMode) *

*

* 坐标无限瘦并且在图素之间躺着那 *输出装置。 *画条线一个身材的大纲操作藉由穿越操作 * 沿着和一枝图素规模钢笔的无限瘦的路径悬挂 *??落和对锚的权利在路径上的点。 *填充一个身材的操作藉由填充内部操作 *无限瘦的路径。 * 提出水平的本文操作提出那上 * 个性的部分完全地在基线同等的人物上面。 *

* 考虑的一些重要的点是那画一条线身材那 * 包括一个给定的长方形将会占领额外图素的排在 * 权利和底部边缘与填充相较一个身材是 *藉着那个相同的长方形跳跃。 * 同时, 画一条线水平线沿着相同的 y 同等的人物当做 *一条本文的线基线在下面将会完全地画那条线线 *除了任何的 descenders 以外的本文。 * 两者都这些财产是由于钢笔悬挂下来和到 *来自它横越的路径权利。 *

*出现如对这的方法来说的争论所有的坐标 *图形物体相对于翻译起源是考虑过的 *这图形在～之前方法的祈愿反对。 * 所有的翻译操作只修正在里面躺着的图素那 *被两者图形上下文的现在修剪跳跃的区域 * 而且成份的范围过去一直产生图形物体。 * *@作家 Sami Shaio *@作家 亚瑟货车 Hoff *@版本 %我%,%G% *@自从～后 1.0 */ 公众的摘要分类图形 { /** * 平局当许多指定的图像之时当做现在可得 * 藉由它的西北角落在指定的同等人物.(x,y) *这一个方法将会立刻在所有的情况归还, 即使那 *整个的图像还没有被依比例决定, 发抖而且转换 *对于现在的输出装置。 *

* 如果现在的输出表现是还未完全的然后 * 方法将会归还错误的和那指出 {@ 联编 ImageObserver} *物体将会被通知为转变程序进步。 * *@param img 图像是憔悴的 *@param x x- 西北的同等人物角落那 * 图素的目的地长方形 *@param y y- 西北的同等人物角落那 * 图素的目的地长方形 *@ param 观察者图像观察者被通知为更多那 * 图像被转换。 五月是 <密码>无效力的 *@回返 <密码>真实的 如果图像完全地 * 装载而且被成功地画; * <密码>错误的以别的方式。 *@见到 图像 *@见到 ImageObserver *@自从～后 1.0 */ 民众摘要 boolean drawImage(图像 img ， int x ， int y, ImageObserver 观察者); /** *解决被这图形上下文用的系统资源。 *图形上下文不能够被在被解决之后用。 *垃圾收集搬运夫的 finalization 程序决意 *也解决相同的系统资源,由于数字 *图形能在短时间体格中被产生的物体 * 它是较好的到用手自由地联合的资源 * 使用这一个方法不愿仰赖 finalization * 不可能发生长的时段程序。 *

* 图形被提供如对于油漆的争论物体 *而且成份的更新方法自动地被处理 * 藉着系统当那些方法归还的时候。 程序师应该, *对于效率, 呼叫那处理方法当使用完 * 一个图形物体只有当如果它直接地被产生从一 *成份或另外的图形反对。 * *@见到 #产生 (int ， int ， int,int) *@见到 #使结束 () *@见到 成份#getGraphics() *@见到 成份#油漆 (图形) *@见到 成份#更新 (图形) *@自从～后 1.0 */ 公众的摘要空虚处理;() /** *一经它是不再叁考，解决这图形上下文。 *@见到 #处理 () *@自从～后 1.0 */ 民众空虚使结束 {() 处理;() } } 修理卷曲的引证 (微软字) 问题 - 如果你正在一个编者中工作，一个问题发生卷曲的 ( 不愿直线) 独身者和两倍的引证假设值, 像是一个个人计算机的微软字 -- 当在一些 browers 中显示，引证消失。 (像是 Unix 网景) 如此一个像 " 展览的特性 " 的片语变成 " 展览特性 " 。 违法的个性是下列各项: 146- 正确地选出引证 147- 左边加倍引证 148- 正确的加倍引证 应该改为被用的是: 39- 笔直地选出引证 34- 直的引证 预防的解决 - 理由被发生的 " 违法的 " 引证是，假设值字选项是 " 变化 ';直的引证 '; 到 '; 聪明的引证". 如果你把这关掉 ,当你打字的时候，你拿适当的直引证。 固定卷曲的引证 - 微软的字有一些救援选项 -- 使用 " 解救当本文唯一的" 把引证改变回直的引证。 确定使用正确的选项: " 只解救如和线休息的本文 "- 在每条线结束的时候插入空间, 而且保存卷曲的引证。 " 如本文的救援唯一的"- 不在每条线结束的时候插入空间, 而且将卷曲的引证换成直的引证。 -------------------------------------------------------------------------------- 脚注 [在爪哇软件的 1], 我们使用 @对于 SCCS 版本的版本。 见到 " 男人 sccs-拿"对于细节。 共识似乎是: %我% 每时间拿增量你编辑和 delget 一个文件 %G% 是日期毫米/ dd/ yy 当你产生一个文件的时候,%我%被设定成 1.1. 当你编辑的时候和 delget 它, 它增量到 1.2. 如果他们找它太困惑的，一些开发者省略日期 %G%( 而且已经这么做)-- 举例来说,3/4/96,%G% 会生产三月 4 日哪一, 会被解释被那些在美国以外意谓四月第三日。 只有当如果他们想要较好的决议，一些开发者包括时间 %U% 。 (在一天中由于多样的报到处) 最清楚的数值日期格式会是有首先与那年一起格式的日期,某事喜欢 yyyy-毫米-dd,如国际标准组织 8601 和其他地方 (像是 http:// www.cl.cam.ac.uk/~ mgk25/iso-time.html) 所计划，但是提高会需要来自 SCCS 。 [作家的意见: 包括来自第 5 步骤的较多意见: ~dkramer/javadocdir/移动-体格-进入-之内src.html#revisproc " 手册编辑被 WebWorks 生产的 HTML 文件 "] -------------------------------------------------------------------------------- 版权 2000 升阳公司,公司 版权所有 用金山快译翻译的 大家将就着看吧

用金山快译翻译的
大家将就着看吧