javascript - 單行注釋應該放在行尾還是代碼上方呢？

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

• 行尾

var var1 = 5; // 聲明並初始設定變數，值為5

• 上方

// 聲明並初始設定變數，值為5var var1 = 5; 

回複內容：

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

• 行尾

var var1 = 5; // 聲明並初始設定變數，值為5

• 上方

// 聲明並初始設定變數，值為5var var1 = 5; 

一般情況下，個人的習慣是：
1、變數聲明或初始化，放在右方
2、簡短代碼塊聲明放在上方
3、注釋過長使用多行注釋，並放在上方

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

行注釋的話一般放在代碼後面，塊注釋的話放在代碼上邊
具體可以參考 連結描述

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

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

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

注釋格式：
1、單行(single-line)注釋：//……
2、塊(block)注釋：/*……*/
3、文檔注釋：/**……*/
4、javadoc 注釋標籤文法

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

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

SAXReader reader = new SAXReader();//建立SAXReader//擷取根標籤下的所有emp標籤Listelements = root.elements();/* * Element提供了擷取中間文本資訊的方法： * String getText() * String getTextTrim() */String name = nameEle.getText();

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

/* 讀取XML檔案 */Document doc = xmlFileReader();

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

個人習慣吧！

我一般代碼太長的，或者需要注釋的文字太多的，會放在代碼上訪，單獨一行或者幾行。

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

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

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

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

看個人習慣或者團隊習慣。

1、簡短代碼塊聲明放在上方
2、注釋過長就使用多行注釋，並放在上方
所以說，個人習慣

我習慣寫上面

寫上面比較好 可以與上一行代碼隔離開 能夠清晰一些

可以試試jsDoc規則
http://usejsdoc.org/
jsdoc明確規定了，註解區塊注釋放上面，單行注釋放右側。
除了公司規定就照這個經念就可以

這個具體看公司代碼規範了，如果沒有代碼規範明確限制，自己寫注釋最好放在上面，不然你一會兒代碼上面一個注釋，一會代碼右邊一個注釋，自己看的時候就覺得亂了

個人習慣放在上面。
ps:注釋用來說明代碼的功能塊或者不太容易理解的模組。不要隨便寫注釋

至於單行注釋寫在上面好還是寫在下面好，都沒關係，我一般注釋都是這樣：

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

說實在雖然放後面比較好看注釋，但用起來有時候很糾結，特別是如果想在數組元素後面加註釋的時候，在加了注釋之後，發現要加一個新元素的時候，需要再去添加,。

栗子：

$test = [    a, //a    b  //b，如果需要在後面添加一個元素，需要補上,號，雖然可以在最後元素加上,不報錯，但是對於強迫症來講，不喜歡多餘的,號]

如果是一個功能的話會在上面，單獨注釋一行代碼的話會在尾部更隨。

注釋只是為了增加代碼的可閱讀性 並且 一般來說 短行代碼 在右側注釋比較友好 而長行代碼 在頭部或下行注釋 便於看清不亂

個人習慣 都在上面 ，單行注釋右邊的話，可能會造成需要拖動捲軸才能看到後面的

盡量寫在上方，方便查看

看注釋長度。。。

不同語言注釋規範也不一樣，python就用#或者""""""，最好跟規範走

習慣......

