Dev Faq
7
votes

/ *! */ Qu'est-ce que ça veut dire?

Je viens de trouver cette déclaration de commentaire dans certains échantillons Xcode: xxx

Le commentaire est vert comme d'habitude, le @property et @ résumé sont vert foncé. Si je retire la marque d'exclamation, ils ont le même vert. Ce que diable signifie cela signifie?

2 commentaires

Liée à Stackoverflow.com/questions/6605535/ ... ?

Ouais tu as raison, merci!

3 Réponses :

3
votes

Dans l'objectif-c, un commentaire n'est délimité que par / * * /, vous avez donc raison, le point d'exclamation n'est pas nécessaire pour former un commentaire. Cependant, dans ce cas, le! Il faut dire que ce mode devrait être lu par un outil de documentation automatique, tel que Doxygen ou Autodoc. Il en va de même pour les @ symboles là-bas. @Property dit que vous documiez une propriété appelée Mastervolume et @Abstract décrivent ce que la propriété est pour.

0 commentaires
3
votes

C'est un style de commentaire QT. Il est traité comme un commentaire de bloc de doxygen , Headerdoc et Appledoc . L'auteur connaissait une programmation QT et a choisi ce style de commentaire. Il aurait pu choisir / ** à la place, juste une question de goût.

0 commentaires
5
votes

Pour effectuer la transition de Headerdoc un peu plus simple, AppleDoc (outil pour générer de la documentation à partir de code de sorte que vous économisez du temps dans la documentation) accepte également les commentaires multilignes de style HeaderDoc Style: 

/*! Comment */

1 commentaires

Donc, fondamentalement, si j'ai AppleDoc, cela va utiliser ce commentaire pour écrire une documentation? agréable :)

Articles qui pourrait vous intéresser :

Comment corriger l'erreur "Hash mismatch for chunk" avec iOS 13 + Apple On Demand Resources
SwiftUI: la fenêtre contextuelle d'édition structurée (Commande + clic) ne s'affiche pas
La construction de Xcode échoue en raison d'un symbole non défini: __swift_FORCE_LOAD _ $ _ swiftUIKit
Problème de périphérique Xcode - Échec de la vérification _shouldMakeReadyForDevelopment même si le périphérique n'est pas verrouillé par mot de passe