JavaScript的使用，這些好評或者它們是否矯枉過正？

我希望在不過於冗長的情況下添加有用的評論。在回答想象給定的Javascript函數被埋在數百或數千行源代碼的某處。另請注意，在評論中，我通過更好地描述它們的用法而不是使用實際的參數名稱給函數參數賦予了更多的含義。我這樣做是爲了更好地指導可能在以後需要重構或修改腳本的用戶（程序員）。JavaScript的使用，這些好評或者它們是否矯枉過正？

var ctx = getCanvas();// getCanvas(width, height) 
    grid(ctx);// grid(context, element size, line width, line color) 

    function getCanvas(width = 200, height = 150) { 
     // code to run 
    } 

    function grid(ctx, elSize = 10, width = .3, color = 'green') { 
     // code to run 
    }

來源

2017-06-23 Jules Manson

best comm ents是很好的函數名稱。閱讀'清潔代碼'書，這是你的問題的答案 –

這是一個絕對的意見爲基礎的問題，因此這是在這裏脫離主題。 –

我不知道爲什麼你會把註釋放在函數被調用的地方 - 爲什麼不把完整的註釋描述函數本身的函數和參數呢？ –

好，Its always good to have your code properly commented.

添加標準/描述性註釋的功能，而不是註釋行開始前。

有很多方法可以在javascript中添加註釋;這裏是我的推薦/最佳實踐。

使用//比/* */更好，因爲那樣你就可以使用後者來取出包含其他註釋的整個塊。但是，如果您想使用自動文檔生成工具，則必須使用類似於javaDoc樣式的註釋。

這是將與YUI DOC工作的範例（最好的）http://developer.yahoo.com/yui/yuidoc/#start

/** 
* This is a description 
* @namespace My.Namespace 
* @method myMethodName 
* @param {String} str - some string 
* @param {Object} obj - some object 
* @param {requestCallback} callback - The callback that handles the response. 
* @return {bool} some bool 
*/ 
    function SampleFunction (str, obj, callback) { 
     var isTrue = callback(str, obj); // do some process and returns true/false. 
     return isTrue ; 
    }

其他PARAMS例子： - http://usejsdoc.org/tags-param.html

來源： -Does JavaScript have a standard for commenting functions?

希望這會幫助你:)

來源

2017-06-29 12:57:37

難的問題，因爲它是下降到您自己的喜好，你還必須考慮那些具有在未來閱讀你的代碼其他開發商。

我個人用一些方法得到了一點「評論疲勞」，但其他人會說你不能評論足夠。我認爲對函數和變量的一個很好的命名規則通常可以消除大部分評論的需要。

來源

2017-06-23 18:06:06 Liondedan

你想要做的是使用JSDoc更好readabilty

/** 
* describe your function 
* @param {number} width - describe your parameter 
* @param {number} height - describe your parameter 
* @return {type} describe your returned value/object 
*/ 
function getCanvas(width = 200, height = 150) { 
    // code to run 
}

這也派上用場了您的IDE

來源

2017-06-23 18:10:02

註釋是編程的好pratics，所以它的，在我看來，，讓代碼更乾淨。例如，當你的代碼需要維護時，其他程序員會理解。我需要評論的東西就是你認爲對其他人理解的必要條件，並試圖說清楚。

來源

2017-06-23 18:22:09

JavaScript的使用，這些好評或者它們是否矯枉過正？

回答

相關問題