2017-03-03 1 views
2

Je crois que la plupart des développeurs suivent les directives mises en place par JSDocs pour commenter en JavaScript. Alors, voici comment je fournis habituellement des commentaires pour la fonction que je crée pour aider d'autres développeurs qui pourraient travailler sur le même fichier:Réagissez: Quelle est la convention de dénomination pour informer le type de retour de la fonction est jsx dans les commentaires?

/** 
    * Renders the translated section in sidebar. 
    * 
    * @param {array} langList - List of languages to be rendered 
    * @param {boolean} isTranslated - If true render translations 
    * @return {JSX} - Returns JSX 
    */ 
    _renderLangSection (langList, isTranslated) { 
    return (
     <div>{isTranslated ? langlist : null}</div> 
    ); 
    } 

Comme vous pouvez le voir le type de retour de cette fonction est JSX. Est-ce le bon type de retour? Ou est Réagissez l'élément un meilleur nom? Est-ce que quelqu'un sait ce que préfère la communauté React?

Répondre

0

Peu importe si vous appelez le type de retour à être JSX comme après cette fonction est compilée avec Babel, le code JSX se transforme à javascript pur comme

function _renderLangSection (langList, isTranslated) { 
    return React.createElement("div", null, isTranslated ? langlist : null); 
} 

qui revient en fin de compte un élément React.