javascript - 單行註解應該放在行尾還是程式碼上方呢？

如果有必要加上單行註解，大家開發一般把 單行註解 放在程式碼行尾，還是獨佔一行放在程式碼的上方呢？還是具體情況，具體分析？是個人習慣，還是有你的理由。希望大家討論，我好學學習。

• 行尾

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

• 上方

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

回覆內容：

如果有必要加上單行註解，大家開發一般把 單行註解 放在程式碼行尾，還是獨佔一行放在程式碼的上方呢？還是具體情況，具體分析？是個人習慣，還是有你的理由。希望大家討論，我好學學習。

• 行尾

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

• 上方

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

一般情況下，個人的習慣是：
1、變數宣告或初始化，放在右邊
2、簡短程式碼區塊宣告放在上方
3、註解過長使用多行註釋，並放在上方

重點是，不要為了註解而註釋，變數、函數等命名規範了，程式碼能清晰看懂就盡量往這個方向努力。畢竟有 “代碼之美”，而未曾聽說有 “註釋之美”。

行註解的話一般放在程式碼後面，區塊註解的話放在程式碼上邊
具體可以參考 連結描述

如果使用formater之類的，單行註解放後邊；不然，有些格式化工具格式化出來的東西略詭異；

註解寫上面吧。一般來說格式化的註釋，然後可以匯出API。

然後就是為了讓你自己看的註釋，你就隨便寫吧。反正除了你也沒人會看你的註解。文件的註解一般都在頭部。隨便寫的註解感覺沒什麼用

註解格式：
1、單行(single-line)註解：//……
2、區塊(block)註解：/*&*/
3、文件註解：/**** &*/
4、javadoc 註解標籤語法

---

從個人的專案經驗來看，情況如下使用比較整潔：

1、變數一般用單行註解，放在行尾，若變數或註解太長，也可放上方，若註解太長，就改用塊註釋，根據情況而定;

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

2、呼叫方法一般用塊註解，放在上方;

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

看到有人提到jsdoc,個人也是使用jsdoc的，提供一個jsdoc 中文版文件。
關於註釋，個人感覺行註釋寫行位，塊註釋寫行首。

個人習慣吧！

我一般程式碼太長的，或是需要註解的文字太多的，會放在程式碼上訪，單獨一行或幾行。

簡短的，類似你這種，就放在程式碼後面。

甚至習慣性的會輸入空的://。

看個人習慣，放後邊更好點

個人認為 關於註釋 要有三個優先級： 項目要求規範為最高級，如果項目沒有要求，那就按照官方標準，如果沒有官方標準，那就按自己的標準。 。 對於自己的標準，引用上面一個回答說的：“不要為了註釋而註釋”，註釋的目的是讓複雜的程式碼清晰易懂

看個人習慣或團隊習慣。

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

我习惯写上面

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

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

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

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

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

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

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

栗子：

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

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

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

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

尽量写在上方，方便查看

看注释长度。。。

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

习惯......