我正在努力改进我的javascript代码的文档,并遵循JSDoc指南https://jsdoc.app/。
我找不到如何记录故意的副作用。例如下面的方法:
/**
* @description
* Paints the object red.
* @return
*/
Painter.paintItRed = function(someObj){
someObj.color = "red";
};
如何记录该方法直接作用于传递的对象这一事实?一个不同的例子:
/**
* @description
* If the user has not setUp a config, show config Modal.
* @return
*/
User.checkConfig = function(user){
if(!user.config.valid){
showConfigModal();
}
};
这些都是人为的例子和可能的“代码气味”,但这是另一个问题。我正在研究一些关于如何记录此类行为的最佳实践(无论是好是坏)。可能比//IMPORTANT!! This method is dangerous!
更好的东西
https://stackoverflow.com/questions/25314979
复制相似问题