利用@see、@link增强程序可读性
2021/5/22 20:26:15
本文主要是介绍利用@see、@link增强程序可读性,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
诸多原因,我们的程序往往解释不了它自己。
即使程序可以解释自己,那么,谁会用它?它跟谁有关系? 这些就用到了@see @link了。
@see的用法:
@see com.....XXXClass
@see com.....XXXClass#XXXMethod
使用@see为class添加注释
/** * 描 述:企业开票申请单的状态枚举 * @see com.emax.zhenghe.rpcapi.modules.bill.vo.EnterpriseInvoiceApplyVO#billStatus * 创 建 者: zhang.gz * 创建时间: 2021-5-20 17:56 */ @Getter @AllArgsConstructor public enum InvoiceApplyStatusEnum { 。。。 }
使用@link为class的成员属性添加注释
public class EnterpriseOnlineAuthVO { 。。。 /** * 认证类型 {@link com.emax.zhenghe.common.enums.OnlineAuthTypeEnum} */ private String authType; 。。。 }
这篇关于利用@see、@link增强程序可读性的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-07-02springboot项目无法注册到nacos-icode9专业技术文章分享
- 2024-06-26结对编程到底难不难?答案在这里
- 2024-06-19《2023版Java工程师》课程升级公告
- 2024-06-15matplotlib作图不显示3D图,怎么办?
- 2024-06-1503-Loki 日志监控
- 2024-06-1504-让LLM理解知识 -Prompt
- 2024-06-05做软件测试需要懂代码吗?
- 2024-06-0514-ShardingSphere的分布式主键实现
- 2024-06-03为什么以及如何要进行架构设计权衡?
- 2024-05-31全网首发第二弹!软考2024年5月《软件设计师》真题+解析+答案!(11-20题)