利用@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;
    
    。。。
    
}

 

上一篇:【数字信号调制】基于matlab GUI PCM编码调制【含Matlab源码 1018期】


下一篇:【预测模型】基于matlab GUI BP神经网络预测【含Matlab源码 934期】