H5W3
当前位置:H5W3 > 问答 > 正文

为什么在注释前面加@param?

如图:
为什么在注释前面加@param?

为什么在注释前面加@param,有没有能细说一下的大神?

回答

这是jsdoc之类的文档语法,可以自动生成相应文档。在一些工具中也会自动提示。
它一般用于函数声明注释。

这是 JSDoc 注释,@param说明后面的 sheet 是一个参数,参见 JSDoc:@param
注明参数之后 IDE 可以在调用函数的时候智能地提示所需参数,参数还可以标注类型和参数说明,给 IDE 更多更准确的提示信息。

@param 是用于标注参数的,参数名、参数类型、参数说明

官方介绍:如果你的映射方法接受多个参数,就可以使用这个注解自定义每个参数的名字。否则在默认情况下,除RowBounds以外的参数会以 "param" 加参数位置被命名。例如 #{param1}, #{param2}。如果使用了 @Param("person"),参数就会被命名为 #{person}。(你可以传递多个参数给一个映射器方法。在多个参数的情况下,默认它们将会以 param 加上它们在参数列表中的位置来命名,比如:#{param1}、#{param2}等。如果你想(在有多个参数时)自定义参数的名称,那么你可以在参数上使用 @Param("paramName") 注解)。

  翻译:@Param(该注解属于MyBatis)作为Dao层的注解,作用是用于传递参数,从而可以与SQL中的的字段名相对应,一般在2=<参数数<=5时使用最佳。

使用方式:

传递参数是指:mapper接口中方法定义的参数 与 mapper.xml(SQL语句)中SQL语句中的参数进行传递(匹配)的过程。

1.传递单个参数时,不需要使用@Param,因为传进去一个值,也只有一个参数与之匹配(当然也可以用@Param)。

2.传递多个参数时,使用@Param可以进行参数的绑定(当然也可以不用,可以封装JavaBean或者使用Map传值)

本文地址:H5W3 » 为什么在注释前面加@param?

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址