javascript - 单行注释应该放在行尾还是代码上方呢?

查看:74
本文介绍了javascript - 单行注释应该放在行尾还是代码上方呢?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

问 题

如果有必要添加单行注释,大家开发一般把 单行注释 放在代码行尾,还是独占一行放在代码的上方呢?还是具体情况,具体分析?是个人习惯,还是有着你的理由。希望大家讨论,我好学习学习。

  • 行尾

var var1 = 5; // 声明并初始化变量,值为5

  • 上方

// 声明并初始化变量,值为5
var var1 = 5; 

解决方案

一般情况下,个人的习惯是:
1、变量声明或初始化,放在右方
2、简短代码块声明放在上方
3、注释过长使用多行注释,并放在上方

重点是,不要为了注释而注释,变量、函数等命名规范了,代码能清晰看懂就尽量往这个方向努力。毕竟有 代码之美,而未曾听说有 注释之美。

这篇关于javascript - 单行注释应该放在行尾还是代码上方呢?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆