Bonnes pratiques dans les en-têtes

:salut: à tous,

Me mettant doucement à Qt version C++, je me pose une question sur une bonne pratique concernant la conception des fichiers d'entête, notamment dans le cas de l'interaction entre le code C++ et QML.

Afin de pouvoir accéder aux fonctions C++ depuis le code QML il y a deux solutions possibles :

• ajouter le "tag" Q_INVOKABLE" ;
• ou mettre la fonction dans public slots.

Question : Quelle différence entre ces deux méthodes, et pourquoi préférer l'une à l'autre.


Tant que je suis dans les bonnes pratiques dans les headers, voici une autre question plus C++ que QML, mais qui devrait trouver réponse ici.

Jusqu'à présent, voici un exemple de ce que je fais pour définir et utiliser une fonction :

Code:

---

1 2 3 4 5

// Fichier .h void test (QString, int)   // Fichier .cpp void test (QString toto, int a)

---

À priori ça fonctionne puisque je n'ai pas d'erreur de compilation.

Cependant, je remarque que souvent la déclaration dans le .h comprends aussi les "noms" des variables ce qui donnerait dans le cas présent :

Code:

---

1 2	// Fichier .h void test (QString toto, int a)

---

Même question que précédemment : Qu'est ce qui est le mieux, il y a t-il une grosse différence dans ces deux utilisations (performance, sécurité, ... ???)

D'avance merci pour vos conseils.


++


J

Citation:

---

Envoyé par Jiyuu

Tant que je suis dans les bonnes pratiques dans les headers, voici une autre question plus C++ que QML, mais qui devrait trouver réponse ici.

Jusqu'à présent, voici un exemple de ce que je fais pour définir et utiliser une fonction :

Code:

---

1 2 3 4 5

// Fichier .h void test (QString, int)   // Fichier .cpp void test (QString toto, int a)

---

À priori ça fonctionne puisque je n'ai pas d'erreur de compilation.

Cependant, je remarque que souvent la déclaration dans le .h comprends aussi les "noms" des variables ce qui donnerait dans le cas présent :

Code:

---

1 2	// Fichier .h void test (QString toto, int a)

---

Même question que précédemment : Qu'est ce qui est le mieux, il y a t-il une grosse différence dans ces deux utilisations (performance, sécurité, ... ???)

---

Oui, ça fonctionne bien sans le nom dans les déclarations car le compilateur n'en a absolument pas besoin.

L'intérêt de le mettre est documentaire.

En effet d'une part le nom des paramètres participe complétement à la documentation de la fonction.
Et d'autre part il est préférable avoir cette documentation dans les en-tête plutôt que dans les sources pour plusieurs raisons :

• L'en-tête est toujours présente même lors de la livraison, même d'une version compilée.
• L'en-tête contient (ou devrait contenir) uniquement l'interface et non l'implémentation, en tant qu'utilisateur d'une API, je me réfère donc à l'en-tête et non aux sources.

Hello,

Sans oublier que les IDEs vont chercher les infos dans le .h pour l'auto-complétion (mais aussi pour donner de la doc sur la fonction : rôle / utilisation / etc...).
La doc (format Doxygen ou autre) doit donc être présente dans le .h et non dans le .cpp.

Il est aussi possible que les noms de paramètres diffèrent entre le .h et .cpp, par exemple

Code:

---

1 2 3 4 5 6 7 8 9 10 11 12 13

// Fichier .h void test(QString fileName, int foo_notUsed);   // Fichier .cpp void test(QString fileName, int) { // si le 2eme paramètre n'est pas utilisé, pas besoin de le nommer // on le nomme dans le .h simplement pour expliquer son rôle : // ici un paramètre qui était utile lors d'une version précédente // mais qui ne l'est plus (et qui reste pour ne pas casser le code) // ou un paramètre pas encore utilisé mais qui le sera lors d'une // prochaine version // (un QString ça ne se passe pas par ref constante habituellement ?) }

---

Je suis d'accord avec ces réponses.

Il y a quand même des cas où l'information n'est pas nécessaire.
En général, quand on aurait tendance à appeler les arguments a et b.
Par exemple, un somme de vecteurs (mathématique), un produit matriciel, ou concaténation de chaine ou autre opérations mathématiques.

Je ne trouverai pas moyenne(T, T) moins lisible que moyenne(T a, T b).

J'irai plus loin avec l'exemple d'Iradrille:
Si un paramêtre est nommé mais non utilisé dans la définition d'une fonction, cela peut lever un warning (gcc: unused parameter)

En ce qui concerne slot / vs Q_INVOKABLE, la différence est qu’une méthode Q_INVOKABLE*pourra être appelée depuis QML, mais pas utilisée dans un connect côté C++, contrairement à un slot.

Sinon, pour répondre à Iradrille, les QString sont implicitement partagés. Donc Qt utilise partout la copie et non le const& (c’est en particulier important pour les paramètres des slots, puisqu’ils peuvent être invokés de manière asynchrone).