首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

在重命名类时,应该对javadoc做哪些更改?

在重命名类时,应该对javadoc做以下更改:

  1. 类名:更新javadoc中的类名,确保与重命名后的类名一致。
  2. 构造函数:如果类有构造函数,更新javadoc中的构造函数名称,确保与重命名后的构造函数名称一致。
  3. 方法:更新javadoc中所有方法的名称,确保与重命名后的方法名称一致。
  4. 参数:如果类的方法有参数,更新javadoc中的参数名称,确保与重命名后的参数名称一致。
  5. 返回值:如果类的方法有返回值,更新javadoc中的返回值类型,确保与重命名后的返回值类型一致。
  6. 异常:如果类的方法声明了可能抛出的异常,更新javadoc中的异常类型,确保与重命名后的异常类型一致。
  7. 注释:检查并更新javadoc中的注释,确保与重命名后的类、方法、参数、返回值等相关内容一致。
  8. 引用:如果其他类或文档引用了被重命名的类,需要更新这些引用,确保与重命名后的类名一致。
  9. 文档链接:如果有其他文档或资源与被重命名的类相关联,需要更新这些链接,确保指向重命名后的类。

腾讯云相关产品和产品介绍链接地址:

腾讯云开发者中心:https://cloud.tencent.com/developer

腾讯云云服务器(CVM):https://cloud.tencent.com/product/cvm

腾讯云对象存储(COS):https://cloud.tencent.com/product/cos

腾讯云人工智能(AI):https://cloud.tencent.com/product/ai

腾讯云物联网(IoT):https://cloud.tencent.com/product/iot

腾讯云区块链(BCS):https://cloud.tencent.com/product/bcs

腾讯云元宇宙(Metaverse):https://cloud.tencent.com/product/metaverse

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

​2019 DevOps 必备面试题——持续集成篇

对于这个答案,你应该关注持续集成的需求。我建议你回答中提到以下解释: 开发和测试的持续集成通过完成所有开发之后替换传统的测试实践,来提高软件质量并减少交付耗时。...Q3:持续集成的成功因素有哪些?...通过重命名目录来重命名现有 job。请注意,如果你更改了 job 名称,则需要更改尝试调用该重命名 job 的所有 job 。 Q5:如何在 Jenkins 中创建备份和复制文件?...从构建中收集信息的可选步骤,例如归档制品、记录 javadoc 和测试结果。 配置构建结果通知其他人/系统的步骤,例如发送电子邮件、即时消息、更新问题跟踪器等。...限制 Jenkins 数据/文件夹的物理访问。 定期其进行安全审核。 点击使用 CODING 体验 DevOps 全工具链敏捷研发

1.4K30
  • 【11】进大厂必须掌握的面试题-持续集成面试

    完成后,将更改提交到共享存储库(版本控制存储库)。 CI服务器监视存储库,并在发生更改时签出更改。 然后,CI服务器提取这些更改并构建系统,并运行单元测试和集成测试。...您可以回答中包括以下几点: 维护代码库 自动化构建 使构建自检 每个人每天都致力于基线 每次提交(到基线)都应该构建 保持快速构建 在生产环境的克隆中进行测试 轻松获取最新交付物 每个人都可以看到最新版本的结果...通过重命名目录来重命名现有作业。请注意,如果您更改作业名称,则将需要更改任何其他尝试调用重命名作业的作业。 Q5。解释如何在Jenkins中创建备份和复制文件? 这个问题的答案确实是直接的。...从构建中收集信息的可选步骤,例如,归档工件和/或记录javadoc和测试结果。 通知其他人员/系统构建结果的可选步骤,例如发送电子邮件,IM,更新问题跟踪器等。 Q7。...使用自定义版本控制脚本Jenkins中自动设置权限/特权的过程。 限制Jenkins数据/文件夹的物理访问。 定期其进行安全审核。 欢迎关注 Java架构师社区公众号.

    1.5K20

    受用一生的高效 PyCharm 使用技巧(五)

    可能由于我有代码洁癖,我花了一个星期其代码进行了大量的重构。 重构代码,免不了要对变量进行重命名。 如果一个一个改,显然不太智能,要知道我们是在用IDE,你也许会说,用搜索全部替换不就行了?...比如下面这段代码,我只想改myfun 里的的test_name,而对于全局下的同名变量是不应该修改的。如果你全局替换,就会有误伤。 ? 这时候,我们如何呢?...可以使用 PyCharm 的 Refactor 功能,它会自动匹配作用域,既做到批量更改,也做到不误伤。 操作方法很简单,先选中你的变量,然后使用快捷键 Shift+F6,就可以直接重命名了。 ?...设置完后,有哪些文件就非常清晰了。 ? 25. 应用搜索,阅读源码必备 你平时若有阅读框架源码的需求或习惯,那你一定要来掌握这个技能。 阅读源码,代码的入口、流程、走向特别重要。...你急需有一种方法,可以快速给你列出有哪些地方调用了这个。 贴心的 PyCharm 早已为你准备好了一切。

    66020

    Java的三种注释

    @version 指定的版本,一般用于注释 @version info 两种标签格式的说明: @tag 格式的标签(不被{ }包围的标签)为块标签,只能在主要描述(注释中该类的详细说明为主要描述...avadoc命令 Javadoc 用法格式如下: javadoc [options] [packagenames] [sourcefiles] 格式的说明: options 表示 Javadoc 命令的选项...2、项目名处单击鼠标右键,然后选择Export...,所示。 3、弹出窗口中选择 Java 文件夹,点击 Java 文件夹下面的 Javadoc,然后点击“Next”,如图所示。...4、选择你要生成 Javadoc 的项目,并更改你想保存的 API 帮助文档地址(默认为工程目录下,建议不要修改)。点击“Finish”,如图所示。...文档注释的格式 在编写文档注释的过程中,有时需要添加 HTML 标签,比如:需要换行时,应该使用,而不是一个回车符;需要分段应该使用。

    81610

    Google Java编程风格指南

    当右括号后面接else或者逗号,不应该换行。...考虑到维护只需要改变一行代码,之前的对齐可以不需要改动。为了对齐,你更有可能改了一行代码,同时需要更改附近的好几行代码,而这几行代码的改动,可能又会引起一些为了保持对齐的代码改动。...这使得IDE或其他静态分析工具能够丢失任何情况发出警告。 4.8.5 注解 注解应用到、方法或者构造方法,应紧接Javadoc之后。每一行只有一个注解。...当使用/* */进行多行注释,每一行都应该以*开始,并且*应该上下对齐。...当描述无法一行中容纳,连续行需要至少再缩进4个空格(注:如果你的缩进统一采用采用4个空格,那么这里就应该是8个空格)。 7.2 摘要片段 每个或成员的Javadoc以一个简短的摘要片段开始。

    99420

    受用一生的高效 PyCharm 使用技巧(五)

    可能由于我有代码洁癖,我花了一个星期其代码进行了大量的重构。 重构代码,免不了要对变量进行重命名。 如果一个一个改,显然不太智能,要知道我们是在用IDE,你也许会说,用搜索全部替换不就行了?...比如下面这段代码,我只想改myfun 里的的test_name,而对于全局下的同名变量是不应该修改的。如果你全局替换,就会有误伤。 ? 这时候,我们如何呢?...可以使用 PyCharm 的 Refactor 功能,它会自动匹配作用域,既做到批量更改,也做到不误伤。 操作方法很简单,先选中你的变量,然后使用快捷键 Shift+F6,就可以直接重命名了。 ?...设置完后,有哪些文件就非常清晰了。 ? 25. 应用搜索,阅读源码必备 你平时若有阅读框架源码的需求或习惯,那你一定要来掌握这个技能。 阅读源码,代码的入口、流程、走向特别重要。...你急需有一种方法,可以快速给你列出有哪些地方调用了这个。 贴心的 PyCharm 早已为你准备好了一切。

    72110

    xwiki开发者指南-XWiki API 参考文档

    作为XWiki API的使用者,你需要知道一些要点: 你不应该使用一个class里面有internal关键字。...如果你依赖于这样的一个,XWiki开发团队是不保证其稳定性。 你应该注意@Unstable注解。当你看到标有此注解的代码就意味着它是一个新的公共API,仍然被认为是不稳定的,并且可以随时更改。...如何找到一个 你可以通过使用XWiki Nexus 查询页面获得maven模块来查找一个Java。输入一个完整的名,你就可以得到所有包含该类的模块。...未来我们的目标是直接在扩展wiki的每个扩展页面提供Javadoc链接。...更旧的Javadocs可以Maven Release repository里找到。例如,对于XWiki Platform Core的Javadoc,可以在这个目录下找到相应版本的javadoc

    64110

    使用Eclipse插件提高Java编码质量

    编码标准(CheckStyle的使用) Eclipse上安装好了CheckStyle插件后,我们来建一个用它跑一下。...这个基本就这四毛病,缺少package-info.java文件,这个文件是做什么的呢?他是用来描述包注释的,有一定的特殊性,要想详细了解请百度。如果你的项目没有太大的影响,可以忽略它。...the previous line  “{” 应该位于前一行  3.Methods is missing a javadoc comment  方法前面缺少javadoc注释  4.Expected...在这之前最好导出一个Eclipse自带的CheckStyle配置文件(sun_checks.xml),然后重命名作为一个外部的配置导进去,这么的目的是导入之后可以修改相应的配置,达到自定义配置的目的(...即你的包要么全是接口,不调用任何其他包(完全是抽象和稳定),要么是具体,不被任何其他包调用。 Cycle:循环依赖的数量。 有个这个报告我们就可以有针对性的代码进行设计和重构。  5.

    1.7K70

    代码手术刀—自定义你的代码重构工具

    01 前言 今年的敏捷团队建设中,我通过Suite执行器实现了一键自动化单元测试。Juint除了Suite执行器还有哪些执行器呢?由此我的Runner探索之旅开始了!...翻阅历史代码,发现不少工程仓库里很多依然是用的IDE生成的getter/setter,如果使用Lombok的@Data注解替换,可以带来几个优点。...回过头来看,如果我们要写一个工具,整个代码工程所有进行全量扫描,并且使用lombok来替换其中的“没有特殊逻辑”的getter和setter,需要哪些步骤。...2.更改源码,例如重命名方法、修改方法体、添加或删除代码行等。 3.可以使用它来生成代码片段,例如创建新的、方法或字段,或者生成代码文档。 在上一章节里就用到了数据提取,源码替换功能。...代码重构应该像手术刀一样,快、准、狠,正所谓君子生非异也,善假于物也。

    12910

    有点长的 Java API 设计清单

    建议接口的实现和继承关系的应该在行为上保持一致性 ▲2.1.8. 建议用抽象而不是接口解耦Api的实现 ▲2.1.9. 建议使用枚举而不是常量 ▲2.1.10. 考虑使用泛型 ▲2.1.11....遵循标准Javadoc的约定 ▲2.7.3. 每种类型开头以一句短小的话概述 ▲2.7.4. 为是否使用以及如何使用该类型提供足够的细节来帮助决定 ▲2.7.5....相关方法的调用中参数为null值的处理保持一致性 ▲3.3.3. 相关方法中参数的名称,类型和顺序需要保持一致 ▲3.3.4. 参数列表中把输出的参数放到输入参数之后 ▲3.3.5....当提供了多个构造方法,遵循指南其进行重载 ▲3.6.7. 建议使用构造方法而不是静态的工厂方法 ▲3.6.8. 考虑使用无参的构造方法 ▲3.6.9....包含哪些API可以回调中使用 ▲3.9.16. 考虑为了描述方法的行为而包含单元测试 ---- PS:如果觉得我的分享不错,欢迎大家随手点赞、转发。

    82030

    有点长的 Java API 设计清单

    建议接口的实现和继承关系的应该在行为上保持一致性 ▲2.1.8. 建议用抽象而不是接口解耦Api的实现 ▲2.1.9. 建议使用枚举而不是常量 ▲2.1.10. 考虑使用泛型 ▲2.1.11....遵循标准Javadoc的约定 ▲2.7.3. 每种类型开头以一句短小的话概述 ▲2.7.4. 为是否使用以及如何使用该类型提供足够的细节来帮助决定 ▲2.7.5....相关方法的调用中参数为null值的处理保持一致性 ▲3.3.3. 相关方法中参数的名称,类型和顺序需要保持一致 ▲3.3.4. 参数列表中把输出的参数放到输入参数之后 ▲3.3.5....当提供了多个构造方法,遵循指南其进行重载 ▲3.6.7. 建议使用构造方法而不是静态的工厂方法 ▲3.6.8. 考虑使用无参的构造方法 ▲3.6.9....包含哪些API可以回调中使用 ▲3.9.16. 考虑为了描述方法的行为而包含单元测试

    51910

    有点长的 Java API 设计清单

    建议接口的实现和继承关系的应该在行为上保持一致性 ▲2.1.8. 建议用抽象而不是接口解耦Api的实现 ▲2.1.9. 建议使用枚举而不是常量 ▲2.1.10. 考虑使用泛型 ▲2.1.11....遵循标准Javadoc的约定 ▲2.7.3. 每种类型开头以一句短小的话概述 ▲2.7.4. 为是否使用以及如何使用该类型提供足够的细节来帮助决定 ▲2.7.5....相关方法的调用中参数为null值的处理保持一致性 ▲3.3.3. 相关方法中参数的名称,类型和顺序需要保持一致 ▲3.3.4. 参数列表中把输出的参数放到输入参数之后 ▲3.3.5....当提供了多个构造方法,遵循指南其进行重载 ▲3.6.7. 建议使用构造方法而不是静态的工厂方法 ▲3.6.8. 考虑使用无参的构造方法 ▲3.6.9....包含哪些API可以回调中使用 ▲3.9.16. 考虑为了描述方法的行为而包含单元测试

    65940

    Proguard 常用规则

    压缩阶段,Proguard从这些入口点开始递归确定哪些成员要被使用,其余的都会被丢弃。 优化阶段,ProGuard进一步优化代码。...只有最终Android,它才不是必需的,因此您可以将其关闭以缩短处理时间。 -android 指定已处理的文件针对Android平台。...保留方法名称,这通常很有用,以确保方法的参数类型不会重命名。他们的签名保持完全不变,并与本地库兼容。...为了理解语法,你应该看看这些例子,但这是一个完整的正式定义的尝试: [@annotationtype] [[!]public|final|abstract|@ ...] [!]...除了方法参数列表不包含参数名称外,字段和方法Java中的定义非常类似(就像在javadoc和javap等其他工具中一样)。

    1.7K20

    Java基础-语法(上)

    i = n; i <= m; i++) { sum = sum + i; } return sum; } } ctrl+s保存后将文件重命名为...4.1 访问控制 default(默认访问):同一包内可见,不使用任何修饰符。使用对象:、接口、变量、方法。 public(公共访问权限):所有可见。...protected(子类访问权限):同一包内的任何其它和不同包中的子类可见,不能修饰接口中的成员变量和成员方法。...注意:不同包中的子类只能通过该子类访问父中 protected 成员,通过其它子类或父都无法访问。 private(当前访问权限):同一内可见,只能被所属访问。...synchronized: 修饰的方法、代码块同一间只能被一个线程访问,不能修饰构造器、成员变量等。 一图以蔽之,如下: 我正在参与2024腾讯技术创作特训营第五期有奖征文,快来和我瓜分大奖!

    19132

    9种处理Java异常的最佳实践

    初学者很难理解,即使是经验丰富的开发人员也可以花费数小时来讨论如何以及应该抛出或处理哪些异常。 这就是为什么大多数开发团队都有一套关于如何使用它们的规则的原因。...」 每当在方法签名中指定异常,也应在Javadoc其进行记录。...因此,请确保Javadoc中添加一个@throws声明,并描述可能导致异常的情况。 /** * This method does something extremely useful ......您可以catch子句中使用它,但绝对不要这样! 如果在catch子句中使用Throwable,它将不仅捕获所有异常,而且还捕获所有Exception。它还会捕获所有Error。...您不知道将来的代码将如何更改。有人可能会删除阻止异常事件的验证,而没有意识到这会造成问题。或者,引发异常的代码被更改,现在引发同一个的多个异常,并且调用代码并不能阻止所有这些异常。

    46110

    IntelliJ Idea快捷键

    25.Ctrl+Q可以看JavaDoc 26.Ctrl+Alt+Space是名自动完成 27.快速打开/文件/符号,可以使用通配符,也可以使用缩写 28.Live Templates!...连续按两次会显示当前所编辑的名。 8 、使用 Refactor|Copy Class… 可以创建一个所选择的的“副本”。这一点很有用,比如,在你想要创建一个大部分内容都和已存在相同的。...15 、要打开编辑器脱字符处使用的或者方法 Java 文档的浏览器,就按 Shift-F1 (右键菜单的 External JavaDoc )。...37 、要快速查看编辑器脱字符处使用的或方法的 Java 文档,按 Ctrl-Q (弹出菜单的 Show Quick JavaDoc 里)即可。...40 、 IDEA 中可以很容易地你的,方法以及变量进行重命名并在所有使用到它们的地方自动更正。

    1.4K60

    Eclipse快捷键-方便查找,呵呵,记性不好

    +  n:重命名   ctrl  +  shift  +  o:导入   ctrl  +  shift  +  r:启动上次运行   ctrl  +  shift  +  f:格式化代码   ctrl... +  y:重做   ctrl  +  s:保存   ---------------------------------------------------------------   用的最多的应该就是...  Shift+Alt+C:  更改函数标记   Ctrl+Shitf+F:  格式化代码   ------------------------------------------------...Shift+T   全局            打开类型层次结构            F4   全局            打开声明            F3   全局            打开外部javadoc...Java编辑器            显示大纲            Ctrl+O   全局            层次结构中打开类型            Ctrl+Shift+H   全局

    80240

    【译】编写高质量JavaScript模块的4个最佳实践

    `; } } 随着时间的推移,我注意到了重构默认导出的(或函数)的困难。重命名原始,使用者模块中的名没有改变。 更糟糕的是,编辑器没有提供有关要导入的名的自动完成建议。...`; } } 使用命名导出,编辑器可以更好地进行重命名:每次更改原始,所有使用者模块也会更改名。 自动完成功能还会建议导入的: ?...通过使用命名的导出而不是默认的导出,可以导入命名组件更轻松地重命名重构和编辑器自动完成帮助。...myModule的模块级范围应该只定义包含少量内容的、函数或变量。 一个组件应该有多少个函数或,这些组件应该如何与每个组件相关联?支持高内聚的模块:它的组件应该紧密相关并执行一个共同的任务。...你使用哪些JavaScript模块最佳做法?

    96120

    Google 出品的 Java 编码规范,强烈推荐,权威又科学!

    不同的对成员的排序可能是不同的。最重要的一点,每个应该以某种逻辑去排序它的成员,维护者应该要能解释这种排序逻辑。...Tip:写多行注释,如果你希望必要能重新换行(即注释像段落风格一样),那么使用 /* ... */。...当整个Javadoc块能容纳于一行(且没有Javadoc标记@XXX),可以使用单行形式。...当描述无法一行中容纳,连续行需要至少再缩进4个空格。 7.2 摘要片段 每个或成员的Javadoc以一个简短的摘要片段开始。...如果一个注释是用来定义一个,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好。

    2.7K40
    领券