• [^] # Re: Code auto-documenté

    Posté par (site web personnel, Mastodon) . En réponse au journal To comment or not to comment. That is the question.. Évalué à 3.

    (function (goog) {
     goog.writeScriptTagToImportScript_ = function (scriptSource) {
     if (!goog.inHtmlDocument_()) return false
     var alreadyLoaded = isAlreadyLoaded(scriptSource)
     if (shouldNotWrite(scriptSource, loadedFromBaseJS)) return false
     doc.write(tag(source))
     return true
     }
     var doc = goog.global.document
     var isAlreadyLoaded = function (source) {
     return /\bdeps.js$/.test(source)
     }
     var shouldNotWrite = function (source, pageWiped) {
     if (doc.readyState != 'complete') return false
     if (!pageWiped) throw Error(errorText(source))
     return true
     }
     var errorText = function (source) {
     return 'Cannot write "' + source + '" after document load'
     }
     var tag = function (source) {
     return '<script type="text/javascript" src="' + source + '"></' + 'script>'
     }
    })(goog)
    
    

    J'ai un peu complété. J'aurais bien aimé avoir un argument contre les personnes qui pensent qu'il est inutile de commenter, mais là je ne suis pas convaincu. Si le commentaire ne fait que répéter le nom de la fonction alors ça ne sert à rien à part prendre de la place. Par exemple le commentaire de src : the script source devient scriptSource. On ne perd pas l'information.