Je m'excuse pour la simplicité de ma question, mais j'essayais de générer de la documentation à l'aide d'AppleDocs ( HTTPS : //github.com/tomaz/appledoc#quick-install )
Je ne suis pas sûr de savoir comment obtenir exactement la configuration. La façon dont je le fais est:
Cependant, comment puis-je l'utiliser réellement dans le sens où j'ai mon projet en Xcode:
3 Réponses :
Ce que je fais toujours, c'est ajouter une nouvelle cible à mon projet qui peut générer une documentation. Vous pouvez accéder à vos phases de votre projet de construction et cliquez sur «Ajouter la cible». Choisissez un agrégat sous Autre et donnez-lui un nom (par exemple le projetDocumentation).
toujours sur l'onglet Phases de construction Aller à "Ajouter une phase de construction" et cliquez sur "Ajouter un script d'exécution". Vous pouvez maintenant coller les éléments suivants et l'ajuster à vos propres paramètres: J'utilise l'Ignore * .m car je n'écris que de la documentation dans mes fichiers d'en-tête. La documentation dans mes fichiers * .m est pour moi seulement (et donc privée).
Lorsque vous construisez cette cible, la documentation est générée comme un doctset Xcode. Ceci est accessible par Alt-Click sur un nom de classe. Consultez le site Web AppleDoc pour commenter la syntaxe. Pour une explication des options de ligne de commande la commande AppleDoc --Help.
J'ai fait - nom de projet dynamique, mais je ne trouve aucune variables similaires pour les 2 autres champs. Aide D:
La manière recommandée est de CLONE GITUB Projet et compilez l'outil de XCOD CODE> E. Comme le clonage GitHub Project créera le lien vers le référentiel principal, il simplifie considérablement la mise à niveau future. Pour installer, tapez les éléments suivants dans le terminal: ~/Library/Application Support/appledoc
~/.appledoc
Cette réponse ne semble pas très utile, l'astucieux a déjà localisé le guide d'installation rapide, ce qui semble être un peu plus qu'une pâte de copie.
Par exemple, comme celui-ci, c'est un en-tête valide avec la documentation de code source pour les derniers Appledoc.
//
// GSUserDefaults.h
//
// Created by Gabor Szabo on 30/01/2013.
//
//
#import <Foundation/Foundation.h>
/*!
@discussion This class manages the user defaults on the device with some extra convenient methods.
## Version information
__Version__: 1.0
__Found__: 2013-01-30
__Last update__: 2013-01-30
__Developer__: Gabor Szabo, TMTI Ltd.
*/
#pragma mark - Interface
@interface GSUserDefaults : NSObject {
}
#pragma mark - Class Methods
#pragma mark - Getters
/// @name Getter methods
/*!
@abstract Returns the value for the key.
@discussion It reads the values from the `NSUserDefaults`.
@param key The key, it must be not `nil`.
@return The value object for the key.
@exception NSException Thrown when the key is `nil`.
@since 1.0+
*/
+ (id)valueForKey:(NSString *)key;
/*!
@abstract Returns a value collection for the keys.
@discussion It reads the values from the `NSUserDefaults`.
@param keys The set of keys, which are affected.
@return The value collection for the desired keys.
@exception NSException Thrown when the key is `nil`.
@since 1.0+
*/
+ (NSDictionary *)valuesForKeys:(NSSet *)keys;
#pragma mark - Setters
/// @name Setter methods
/*!
@abstract Sets a value for the selected key.
@discussion The value always will be overridden. It sets the value to the `NSUserDefaults`.
@param value The value object, it can be `nil`, in case of `nil` the key will be removed from the `NSUserDefaults`.
@param key The key for the value, it cannot be `nil`.
@exception NSException Thrown when the key is `nil`.
@since 1.0+
*/
+ (void)setValue:(id)value forKey:(NSString *)key;
/*!
@abstract Sets `nil` values for the selected keys.
@discussion The value always will be overridden. It removs the from the `NSUserDefaults`.
@param keys The set of keys, which are affected.
@since 1.0+
*/
+ (void)setNilValueForKeys:(NSSet *)keys;
/*!
@abstract Sets a default value for the selected keys.
@discussion It the key already exists, it won't be overridden, if the value was `nil` for the key, the key gets the value. It sets the values to the `NSUserDefaults`.
@param defaultValue The value object, it could be `nil`, in case of the `nil` just nothing will happen, the keys won't be removed.
@param keys The set of keys, which are affected.
@since 1.0+
*/
+ (void)setDefaultValue:(id)defaultValue forKeys:(NSSet *)keys;
/*!
@abstract Sets the value for the selected keys.
@discussion The values always will be overridden, if the value was `nil` for the key, the key gets the value. It sets the values to the `NSUserDefaults`.
@param value The value object, it can be `nil`, in case of `nil` the key will be removed from the `NSUserDefaults`.
@param keys The set of keys, which are affected.
@since 1.0+
*/
+ (void)setValue:(id)value forKeys:(NSSet *)keys;
@end
Comment documentez-vous un @property dans les commentaires d'en-tête?
De cette façon, c'est exactement le même que possible pour le @interface.