如何把无用的代码注释为 Deprecated 弃用

最新推荐文章于 2024-08-16 10:31:28 发布
原创 最新推荐文章于 2024-08-16 10:31:28 发布 · 846 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#javascript #vscode

在代码开发中，当需要更新版本并保留旧代码以确保兼容性时，@deprecated注释是一个有效的工具。它用于通知后续开发者某段代码已被弃用，不应再使用。通过添加此注释，可以维护代码的整洁性和可维护性。

代码开发过程中，总会出现更新的版本代码，而老的代码由于需要兼容等等考虑，不能直接删除，但是保留着也需要提示后续开发者不能再继续使用， 这个时候就需要用到注释的 @depreacted，来说明该段代码弃用：


楷鹏 : )
关注
json_to_dataset 详解(写成注释的形式）（添加了可以过滤掉无效json文件的代码）
Holy_cow的博客
09-28 719
【代码】json_to_dataset (详解）
【idea设置】idea去掉用法、继承提示
欢迎~
04-22 813
敲代码的时候感觉用法提示太占位置了，这篇文章写了怎么把用法提示去掉
idea中注释代码取消代码的快捷键
weixin_47792933的博客
08-05 4788
idea中的注释主要分为以下三种 单行注释：// 注释内容（用的最多）:Ctrl+/,选中代码第一次按下注释，第二次按下取消注释，取消时也不需要选中。 多行注释：/* 注释内容*/（不推荐）：Ctrl+shift+/,第一次选中要注释的代码块按下注释，第二次光标定位在注释的代码处，不需要选中注释代码，按下组合键取消注释。 文档注释： /** 文档注释 */（常见于方法和类之上描述方法和类的作用)，可用来自动生成文档。“输入/**,点击Enter”,自动根据参数和返回值生成注释模板。 ...
Javascript 已被弃用的或删除的特性（V客学院知识分享）
weixin_30783913的博客
07-27 792
JavaScript语言更新很快，ES6现在正在盛行的同时，ES7/ES8的规范标准即将面试。随着javascript的不断更新，那些已经被废弃的(仍然可用,但未来会被删除)或者已经过时的(已经被删除,不能再用了)JavaScript特性，可能任然被使用，这里把它们列出来以做学用。 废弃特性（仍然可以使用） 1.RegExp全局对象的属性。下面的这些属性已经被废弃.注意,这和替换字符串中使用...
五种应该避免的代码注释
weixin_30466039的博客
07-28 193
本文来自陈皓的个人网站《酷壳》，文中列举了某国外的程序员提出的五种应该避免的程序注释，陈皓对此发表了自己观点，全文见下： 在酷壳，有很多文章都提到了代码注释，如：《十条不错的编程观点》、《优质代码的十诫》、《整洁代码的4个提示》、《惹恼程序员的十件事》等等。今天，某国外的程序员在这里列举五种应该避免的程序注释，我觉得比较有道理，但我觉得有少数几个观点也并不绝对。所以，我把原文的这五种...
java代码中弃用备注
最新发布
weixin_40298355的博客
08-16 213
我整理的一些关于【Java】的项目学习资料（附讲解～～）和大家一起分享、学习一下：https://d.51cto.com/bLN8S1如何在Java代码中添加弃用备注 在软件开发过程中，标记某些方法、类或字段为“弃用”（Deprecated）是一种重要的实践。它可以提示其他开发者该部分代码可能会在未来的版本中被移除，因此...
Liferay Portal中清理无用Portlet代码的方法
建议采用“先注释后删除”的渐进式策略，即先将废弃代码打上 `@Deprecated` 注解并添加说明，经过一段时间观察无异常后再彻底移除。同时，更新项目的文档，包括架构图、接口说明、部署手册等，保持与代码的一致性。 ...
Broccoli Defeatureify：弃用功能与调试语句删除工具
例如，Babel 插件可以通过配置来移除无用的代码路径（dead code elimination），而 ESLint、Prettier 等代码质量工具则可以帮助开发者在开发过程中自动检测并移除未使用的代码。 在使用任何构建工具和插件时，...
Java方法注释技巧及演示案例
为Java方法编写注释是提升代码质量的关键步骤。良好的文档注释有助于团队协作，减少沟通成本，并最终提高开发效率。在实际开发中，应养成编写高质量注释的习惯，确保代码的可读性和可维护性。此外，掌握如何利用...
JAVA开发规范手册1.50：注释的艺术：如何正确使用注释提升代码可读性
接着，文章深入探讨了注释策略对于提高代码可读性和可维护性的贡献，以及如何通过优化和重构注释来提升代码质量。在团队协作方面，我们讨论了注释如何促进编码规范的统一和提升代码审查的效率。此外，文章还介绍了...
java接口废弃注释_Java注释Override、Deprecated、SuppressWarnings详解
weixin_28848833的博客
02-28 3507
四、如何对注释进行注释这一节的题目读起来虽然有些绕口，但它所蕴涵的知识却对设计更强大的java程序有很大帮助。在上一节讨论了自定义注释，由此我们可知注释在J2SE5.0中也和类、接口一样。是程序中的一个基本的组成部分。既然可以对类、接口进行注释，那么当然也可以对注释进行注释。使用普通注释对注释进行注释的方法和对类、接口进行注释的方法一样。所不同的是，J2SE5.0为注释单独提供了4种注释。它们是T...
vscode ` ` 里面的内容 是删除线，如何去除
sun007700的专栏
04-02 814
在设置界面中，勾选“Show Deprecated”项的方框，这样就能成功地设置为弃用变量加删除线。
Python标记函数或类为废弃(deprecated)并在Pychram或Idea中检测提示删除线
热门推荐
白杨
05-12 2万+
在python中，如果你有函数或者类当下没有作用，或者即将废弃，但是你又不想删除，那么你可以标记为deprecated。其实我更想做的是什么？能够让我标记的函数或者类在其它地方使用的时候，能有直观的提示。用Idea做java开发的童鞋肯定很清楚，java代码中的类或者函数只要标记了@Deprecated注解，在所有使用它的地方都会有删除线很直观的标记出来。 那么，PyCharm或者Idea使用Python插件是否也有对Python进行deprecat
呜呜 写的代码被弃用了 放到这里 留个纪念
fanxiaochuan的专栏
01-10 491
//制作cell行高 - (void)calCellHeight {     for (int i = 0;i     {         CGFloat firstColHeight = PERSONAL_PICFLOW_GAP;         CGFloat secondColHeight = PERSONAL_PICFLOW_GAP;         //cell的布局设置
java 废弃注解_Java 注解
weixin_33199783的博客
02-20 1万+
什么是注解呢？还记得Class是什么吗？注解就是Class对象中的⼀⼩段信息/⽂本/标记，它可以携带参数，可以在运⾏时被阅读。这就是注解的全部了。怎么处理注解并不是注解要关注的信息，它只是这么一小段信息。可用如下代码新建一个注解。public @interface MyAnnotation{}JDK自带了一些注解：@Deprecated 一些废弃的方法可以写上这个注解，用的时候会用中划线提示已被废...
Code Annotation
Angelo Lee's Blog
08-17 501
好的注释风格： 一、注释Why 注释应该是注释Why，而不是How和What。代码告诉你How，而注释应该告诉你Why。但大多数的程序并不知道什么是好的注释，那些注释其实和code是重复的，毫无意义。 应该避免的代码注释 一、自恋型注释 public cla
在JavaScript中弃用代码的方法
06-03 1336
最近，我研究Java中代码弃用这方面的话题。我觉得这个话题的覆盖范围较小，尽管它可能在某些项目中发挥关键作用，特别是在大型团队中工作或处理外部API时。 在Java-land中，我不知道任何真正的用于废弃Java的行业标准。每个团队，库或供应商可能会有所不同。 这就是为什么我的目标是总结我在这个主题上的发现和想法，以及一些好的做法，以便标记Java方法过时的时候。 “弃用”实际上意味着什么？ 首先，我们首先澄清，弃用只是应用于软件功能的状态。它表明应该避免使用此功能，通常是因为它已被取代。 弃用也
java弃用一个方法的注解
行者常至
11-11 1万+
@Deprecated
Deprecated
allanGold
07-31 1981
Deprecated 表示弃用的或者过时的
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值