webstrom的注释

　　今天我们小组的新同学有一个BUG调不好,然后我就帮他调一下.在调试的过程中非常累,纠其原因还是他注释写的不完善.我们可以看一下,他是这样写注释的(随便拿一个方法举例),如下图:

　　乍一看,是不是觉得他的注释挺规范的,其实不然.我们在调用的这个方法的时候,并不会有提示.如图所示:

　　

　　然后我就问他,你为什么不写有提示的注释呢?他很惊讶的告诉我他上家公司都是这样写的,并不知道注释可以有提示,这也让我意识到并不是所有的人都知道这事儿,然后也让我下定决心把入职培训给充分完善(当然,这是后话).

　　那么接下来,我就简单介绍一下webstrom的方法应该如何写注释:首先在方法名上方输入/**,然后按下键盘的enter键,会出现如图所示的内容:

　　

　　我们可以非常清楚的看到@param和@returns分别代表参数和返回值,所示我们需要在他们后面完成相应的补充说明即可.注意:补充说明写在{}里面.如下图所示:

　　

　　那么接下来我们看我们在调用此函数的时候会有哪些变化,如下图所示:

　　

　　是不是我们在调用的时候会提示我们参数,返回值的意义及类型.同样的,写完方法体,在写参数的时候一样会有说明,如下图所示:

　　

　　所以以后建议大家在使用webstrom写注释的时候都这么写.