Xcode 5's new features yorum özel bir sözdizimi ile kendi kodunuzu belgelemek için yeteneğidir. Biçimi Doxygen benzer, ama sadece those features alt destekler görünüyor.

Komutları desteklenen ve olanlar değil mi?
- Kullanımları herhangi bir Doxygen farklılık gösteriyor?

İşte böyle büyük mükafat 5.0.2 olarak buldum tüm seçenekleri bir örnek

Bu kod ile Oluşturuldu:

/** First line text.

 Putting \\n doesn't create a new line.\n One way to create a newline is by making sure nothing is on that line. Not even a single space character!

 @a Italic text @em with @@a or @@em.

 @b Bold text with @@b.

 @p Typewritter font @c with @@p or @@c.

 Backslashes and must be escaped: C:\\foo.

 And so do @@ signs: user@@example.com

 Some more text.
 @brief brief text
 @attention attention text
 @author author text
 @bug bug text
 @copyright copyright text
 @date date text
 @invariant invariant text
 @note note text
 @post post text
 @pre pre text
 @remarks remarks text
 @sa sa text
 @see see text
 @since since text
 @todo todo text
 @version version text
 @warning warning text

 @result result text
 @return return text
 @returns returns text


 @code
// code text
while (someCondition) {
    NSLog(@"Hello");
    doSomething();
}@endcode
 Last line text.

 @param param param text
 @tparam tparam tparam text
 */
- (void)myMethod {}

Notlar:

• Komutları /// //! ** 3*,* 2 ya da öneki olmalıdır.
• Komutları @ (headerdoc tarzı) veya \ (doxygen tarzı) öneki ile çalışır. (I. e. @b \b Her ikisi de aynı şey.)
• Komutları genellikle tarif etmektedirler öğeden önce gelir. (I. e. eğer bir özellik belgesi için çalışıyorsanız, açıklama @property metin önce gelmelidir.) Daha sonra, *, , *, *14/**<*13 11**aynı hat üzerinde onların gelebileceği.
• Belgelerine ekleyebilirsinizsınıflar, fonksiyonlar, özelliklervedeğişkenler.
• Bu komutlar tüm koyu yeşil renkte geçerli komutları @returns dışında olduğunu belirtmek için görünür.
• Belgelerinize son değişiklikler ortaya çıkmadan önce (veya böyle büyük mükafat yeniden) projenizi inşa etmek gerekebilir.

Bkz:

1. Kod tamamlama sırasında, kısa bir metin görürsünüz:

Bu haritayı kısa metni (biçimlendirme yok); eğer kısa bir metin var, bunu gösterecek bir birleştirme tüm metin ilk @block; eğer hiçbiri (örneğin başlamadan @return), sonra herhangi bir parametre tüm metin, çizgi ve uzak tüm @emrediyor.

2. Seçeneğini tıklayarak bir tanımlayıcı adı:

3. Hızlı Yardım Inspector panelinde

(İlk ekrana bakın.)

4. Doxygen

Böyle büyük mükafat 5 komutları Doxygen ile uyumlu olduğundan, indirme ve Doxygen belge dosyaları oluşturmak için kullanabilirsiniz.

Diğer Notlar

Genel bir giriş Doxygen için ve Objective-C belgesi nasıl kodu this page iyi bir kaynak gibi görünüyor.

Desteklenen komutlar: bazı açıklamaları

• @brief: açıklama alanı başında metin ekleme ve kod tamamlama sırasında görünen tek metindir.

Aşağıdaki çalışmaz:

• \n: bir yeni satır oluşturmak değildir. Bir yeni satır oluşturmak için bir yolu yok, bu hat üzerinde olduğundan emin yaparak. Tek bir boşluk karakteri bile!
• \example

Aşağıdaki (hatta koyu yeşil görünür değiller) desteklenir:

• \cite
• \docbookonly
• \enddocbookonly
• \endinternal
• \endrtfonly
• \endsecreflist
• \idlexcept
• \mscfile
• \refitem
• \relatedalso
• \rtfonly
• \secreflist
• \kısa
• \Pasajı
• \tableofcontents
• \vhdlflow
• \~
• ". \
• .
• ::
• \|

Apple ayrılmış anahtar sözcükler:

Apple sadece kendi belgelerinde çalışan ayrılmış bir anahtar gibi görünen kullanır. Koyu yeşil renkte görünürler, ancak, Apple gibi kullanamayız gibi görünüyor. AVCaptureOutput gibi dosyaları Apple'ın örnekler görebilirsiniz.h.

İşte bu anahtar kelimeler bazılarının bir listesi:

• @soyut, @kullanılabilirliği, @class, @tartışma, @onaylanmadı, @yöntemi, @emlak, @protokolü, @, @ref. ilgili

En iyi ihtimalle, anahtar kelime, Açıklama alanı (@örneğin tartışma) yeni bir satır neden olur. En kötü ihtimalle, anahtar ve hızlı yardım içinde görünmez herhangi bir metin (örneğin @sınıf).