这样写代码注释。
link管理。
大家好,今天跟大家分享一些实用的文档标记,也就是注视上面的标记。比如像这个作者标记,还有一些雷特标记是比较常见的,还有一些参数标记,时间标记是比较常见。比如这是supreme里面的restctrl的注解,它上面的一些文档的一些标记平时用的就会比较少,比如像link标记、扣的标记、还有一些标签,杠迪、杠币这些标签其实用的是比较少,但其实真正用起来还是用的会比较舒服一些。
比如像link 注解上面的一个类的注解。现在就是我先来介绍一下就是link注解。link 注解相当于是把它链接到这个文档,这个链接到另外一个类或者字段或者方法上。比如像这个是链接到字段上,这个是链接到字段上链接相当于是一个花括号了。
link可以指定链接到哪一个类或者哪一个类的字段,或者哪个类的一些方法截图。像这边就是另看到业务端源字段,这个点一下就会直接链接到业务异常这个类上面,这边是链接到业务异常里面的aircode的值班,点一下就可以直接链接过来。
然后这边就是链接到指定的字段,也就是媒体字,媒体字就连接到这个,如果是链接,如果链接是本地,本子就可以省略掉前面的一个类型,这边是本类的设置默认错误,还有这个方法我会点一下就可以直接到这边来了,这也是一个链接到本类的方法。
这就是link的作用。link作用主要就是用来链接,比如一些描述,可以添加一下描述,比如像这个就是link一下这个描述。
然后我后面是一个label,就是说真正在文档上显示的是显示elco的,但是你点一下是链接到前面的业务异常里面的elco 的。
看下显示其实就是这样,你看其实默认就会是显示后面这个r扣的,但是前面的那些具体是哪个就不会显示,但可以这边还是可以点,点进去的时候还是到那个,可以点进来还是看到这个,可以看到是异常里面的字段,相当于是语法就是atlink,真正的是哪一个字段或者方法。后面label就是真正显示的标签,前面就不会不会显示了。
就比如这样子,包括link,链接到毕业业务异常,井号看哪个字段,比如链接到这个方法上,可以在这边写上或获取错误方法,真正在文档上显示就会只会显示这个,但是在前面这一段不会显示,真的这边按下来是哪里,你看这边会显示的就是获取错误码方法,前面就是刚才加了就是这个获取错误码方法,点一下,就会链接到这个方法上。
但是前面,这样写就不会显示。如果没有加默认是显示没有加uni签,默认是显示这个类型。就显示的是link左右link,还有一个类似的文档,这个笔记代表的细,相当于是与字段相呼应的一些接口或者字段或者字段或者方法可以标记出来,比如这边是业务端、业务异常,也可以是用类似井号去引用字段。
还有一些字段都是类似的,跟link类似,主要是理科,拿来链接与字段相关的一些接口或者字段方法。那就是link的作用,宁可还可以看到这边一些标签,比如像br标签换行,就是跟htm里面一样的意义就是换行,所以换两行,正常没有加这些标签全部都是粘在一起,相当于也没有换行,也没有空格。
如果换行了之后显示看上去会更舒服,比如像这样子就会一段一段的显示出来,不然全部都粘在一起,看上去就很不舒服。还有一个就是cod标记,真正在文档上显示是没有什么太大的区别,比如像这边cod设置默认错误码,这边是在这边code设置默认错误码,显示还是是普通文本,但是真正就是让点进来的时候可以知道很明显的知道这是一段代码,更有移化,就是一段代码是一段代码,可以觉得是俊也是一个类,所以也可以加上x扣的会更羽翼化一些。
然后这边就是pnr96,也就是cas里面的p r一样,这里面是空格或者换行都会保留下来,要不然这些文本都是全部粘在一起。比如像正常就会显示显示的,会更舒服,然后就会把这些把p r e 里面标签内容是怎么样的显示出来,这边就是显示小小的demo,要怎么怎么使用它?这个就是p i e 的主页,这里面也是代码,所以往上一个扣的标记就更有羽翼化一些,这就是叉的作用。
可以看下这个,就是真正在调用的时候其实可以看上去会更舒服一些,比如根本不知道这个是什么意思,这个类似干什么,用点上来。效果就是加上这些标记和标签的主要作用就是让注释,还有文档会提示的更更好看一些,然后更有意义化一些。比如像这些,不满业务状元类不满足,状元条件十多抛业务状元类到底是哪个业务遗产。
比如这边大家可以看到它抛的是包厢面的业务遗产,已经是哪一些错误码这些,也可以各个系统可以通过设置默认错误码,我为它设置独有的默认错误码,可以点进来可以看到是哪一个方法,这样看上去就会更更舒服一些。
然后link比较有用的地方在业务中开发,比较我觉得比较有用的地方就比如像这个社会史 apido这个一个实体,然后我用一个,这里面有一个字节会史id,它引用的是一个社会史do里面的组件,这就是如果正常对业务不熟悉,一进来看看设备cid到底是哪一个字体的,可能就不知道,就可以在这上面注视的时候给他link一下link到到service d o里面去,这样如果对业不熟的人就可以直接自己就会看到。
比如点进来,这位是 id,哪一个直接原来是链接到设为 stu,这个是引用的是实体组件,就可以直接原来是组件,就可以更方便的看到。
然后这就是link,比较重要的作用在正常。在日常的开发中我觉得link还是比较实用一些,像其他标签也挺实用的。今天的分享就到这边,感谢大家的观看。