0

0

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

php中文网

php中文网

发布时间:2016-12-01 00:25:16

|

2518人浏览过

|

来源于php中文网

原创

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

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

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

回复内容:

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

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

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

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

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

行注释的话一般放在代码后面,块注释的话放在代码上边
具体可以参考 链接描述

如果使用formater之类的,单行注释放后边;不然,有些格式化工具格式化出来的东西略诡异;

注释写上面吧。一般来说格式化的注释,然后可以导出API。

然后就是为了让你自己看的注释,你就随便写吧。反正除了你也没人会看你的注释。文档的注释一般都在头部。随便写的注释感觉没什么用

注释格式:
1、单行(single-line)注释://……
2、块(block)注释:/*……*/
3、文档注释:/**……*/
4、javadoc 注释标签语法


从个人的项目经验来看,情况如下使用比较整洁:

1、变量一般用单行注解,放在行尾,若变量或注解太长,也可放上方,若注解太长,就改用块注释,根据情况而定;

SAXReader reader = new SAXReader();//创建SAXReader
//获取<List>根标签下的所有emp标签
List<Element>elements = root.elements();
/*
 * Element提供了获取中间文本信息的方法:
 * String getText()
 * String getTextTrim()
 */
String name = nameEle.getText();

2、调用方法一般用块注解,放在上方;

/* 读取XML文件 */
Document doc = xmlFileReader();

看到有人提到jsdoc,个人也是使用jsdoc的,提供一个jsdoc 中文版文档。
关于注释,个人感觉行注释写行位,块注释写行首。

个人习惯吧!

我一般代码太长的,或者需要注释的文字太多的,会放在代码上访,单独一行或者几行。

简短的,类似你这种,就放在代码后面。

甚至习惯性的会输入空的://

AI改图神器
AI改图神器

AI万能图片编辑器,一键抠图,去水印,智能图片美化,照片转漫画,照片变活转视频,图片无损放大,一键背景虚化,位图智能转矢量图

下载

看个人习惯,放后边更好点

个人认为 关于注释 要有三个优先级: 项目要求规范为最高级,如果项目没有要求,那就按照官方标准,如果没有官方标准,那就按自己的标准。。 对于自己的标准,引用上面一个回答说的:“不要为了注释而注释”,注释的目的是让复杂的代码清晰易懂

看个人习惯或者团队习惯。

1、简短代码块声明放在上方
2、注释过长就使用多行注释,并放在上方
所以说,个人习惯

我习惯写上面

写上面比较好 可以与上一行代码隔离开 能够清晰一些

可以试试jsDoc规则
http://usejsdoc.org/
jsdoc明确规定了,注释块注释放上面,单行注释放右侧。
除了公司规定就照这个经念就可以

这个具体看公司代码规范了,如果没有代码规范明确限制,自己写注释最好放在上面,不然你一会儿代码上面一个注释,一会代码右边一个注释,自己看的时候就觉得乱了

个人习惯放在上面。
ps:注释用来说明代码的功能块或者不太容易理解的模块。不要随便写注释

至于单行注释写在上面好还是写在下面好,都没关系,我一般注释都是这样:

// XXX功能 start
...
do {
    xxxxx...
} while(x...);
...
// XXX功能 end

说实在虽然放后面比较好看注释,但用起来有时候很纠结,特别是如果想在数组元素后面加注释的时候,在加了注释之后,发现要加一个新元素的时候,需要再去添加,

栗子:

$test = [
    a, //a
    b  //b,如果需要在后面添加一个元素,需要补上,号,虽然可以在最后元素加上,不报错,但是对于强迫症来讲,不喜欢多余的,号
]

如果是一个功能的话会在上面,单独注释一行代码的话会在尾部更随。

注释只是为了增加代码的可阅读性 并且 一般来说 短行代码 在右侧注释比较友好 而长行代码 在头部或下行注释 便于看清不乱

个人习惯 都在上面 ,单行注释右边的话,可能会造成需要拖动滚动条才能看到后面的

尽量写在上方,方便查看

看注释长度。。。

不同语言注释规范也不一样,python就用#或者"""""",最好跟规范走

习惯......

相关文章

java速学教程(入门到精通)
java速学教程(入门到精通)

java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

9

2026.03.16

chatgpt使用指南
chatgpt使用指南

本专题整合了chatgpt使用教程、新手使用说明等等相关内容,阅读专题下面的文章了解更多详细内容。

22

2026.03.16

chatgpt官网入口地址合集
chatgpt官网入口地址合集

本专题整合了chatgpt官网入口地址、使用教程等内容,阅读专题下面的文章了解更多详细内容。

52

2026.03.16

minimax入口地址汇总
minimax入口地址汇总

本专题整合了minimax相关入口合集,阅读专题下面的文章了解更多详细地址。

21

2026.03.16

C++多线程并发控制与线程安全设计实践
C++多线程并发控制与线程安全设计实践

本专题围绕 C++ 在高性能系统开发中的并发控制技术展开,系统讲解多线程编程模型与线程安全设计方法。内容包括互斥锁、读写锁、条件变量、原子操作以及线程池实现机制,同时结合实际案例分析并发竞争、死锁避免与性能优化策略。通过实践讲解,帮助开发者掌握构建稳定高效并发系统的关键技术。

10

2026.03.16

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

116

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

142

2026.03.12

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

412

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

65

2026.03.10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 6.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号