javascript - JavaScript メソッドの副作用の文書化

Question

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!