我希望在不過於冗長的情況下添加有用的評論。在回答想象給定的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
}
best comm ents是很好的函數名稱。閱讀'清潔代碼'書,這是你的問題的答案 –
這是一個絕對的意見爲基礎的問題,因此這是在這裏脫離主題。 –
我不知道爲什麼你會把註釋放在函數被調用的地方 - 爲什麼不把完整的註釋描述函數本身的函數和參數呢? –