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

Question

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

• 行尾

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

• 上方

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

Answer 1

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

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

Answer 2

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

Answer 3

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

Answer 4

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

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

Answer 5

注释格式：
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();

Answer 6

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

Answer 7

个人习惯吧！

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

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

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

Answer 8

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

Answer 9

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

Answer 10

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

Answer 11

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

Answer 12

我习惯写上面

Answer 13

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

Answer 14

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

Answer 15

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

Answer 16

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

Answer 17

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

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

Answer 18

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

栗子：

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

Answer 19

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

Answer 20

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

Answer 21

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

Answer 22

尽量写在上方，方便查看

Answer 23

看注释长度。。。

Answer 24

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

Answer 25

习惯......