前言

想要成为一名优秀的程序员，首先应该具有的是良好的编程素养，而规范化地写注释则是里面非常重要的一环。

正文

 function phoneNumber(numbers) {
return"("+numbers[0]+numbers[1]+numbers[2]+")"+' '+numbers[3]+numbers[4]+numbers[5]+'-'+numbers[6]+numbers[7]+numbers[8]+numbers[9]

 }

如果我直接丢出这一串代码，你第一眼看过来，心里肯定会想“什么玩意？这一坨代码是干什么用的！居然还需要我拖动横条？！”
但是我如果在它的上方加上这样一段注释，并中途给它换行两次，它就会变成这样

/**

 * @func 返回固定格式的电话号码, (123) 456-7890

 * @param array [1,2,3,4,5,6,7,8,9,0]

 * @return (123) 456-7890

 * @author xsir

 */

 函数定义
function phoneNumber(numbers) {
return"("+numbers[0]+numbers[1]+numbers[2]+")"

+' '+numbers[3]+numbers[4]+numbers[5]

+'-'+numbers[6]+numbers[7]+numbers[8]+numbers[9]

}

你一眼看过去就能清楚的看到，这个函数的作用是返回固定格式的电话号码，
调用函数需要输入的形参的样式是一个数组，返回值为固定格式的电话号码，函数的作者是xsir。

在大公司做程序开发的时候，一整个大的项目需要多人协作一同完成，所以代码的可读性就显得尤为重要，甚至可以说，代码的可读性高于一切，因为在这个时候你的代码不仅仅是写给你自己看和用的，而是整个开发团队的同志们都需要能快速看懂并且调用的。

如果别人看你写的代码时，仅仅只有代码而没有任何其他注释，那么他就需要整体的阅读你写的所有代码，才能知道你写的函数是干什么用的，这就会浪费很多时间。“Time is money, efficiency is life！”

顺带一提，如果你使用的是'${}'的格式

phoneNumber = (numbers) => `(${numbers[0]}${numbers[1]}${numbers[2]}) ${numbers[3]}${numbers[4]}${numbers[5]}-${numbers[6]}${numbers[7]}${numbers[8]}${numbers[9]}`

运行上述代码，输出的结果是这样的：

为了提高代码可读性，你对它进行了换行

phoneNumber = (numbers) => `(${numbers[0]}${numbers[1]}${numbers[2]})
${numbers[3]}${numbers[4]}${numbers[5]}

-${numbers[6]}${numbers[7]}${numbers[8]}${numbers[9]}`

那么输出结果就会变成这样

并没有达到预期的效果。所以在实战过程中使用'${}'需谨慎。

总结

在我们开发学习的过程时就要养成良好的编程素养，每次写完一块代码就写好这块代码的注释，做到看“码”知意。同时也要避免单行代码写的过长，尽量使你的代码不需要拖动横条就能看完。