Amaç C @property Yorumlar

Question

Hedef c kodum için dokümanlar oluşturmak için Doxygen kullanıyorum. Şimdiye kadar, özellikleri doğru bir şekilde belgelemek için herhangi bir yönlendirme bulamadık. Baktığım örnekler, akla gelebilecek her şeyi yapıyor. Bazı insanlar değişkenleri kendileri belgelemekte, bazı insanlar ise @ bildirimlerini beyan etmektedir. Bazıları // kullanırken diğerleri diğerleri/** */bloklarını kullanır.

Herkes bana en iyi uygulamalar için referans gösterebilir mi? Ya da belki Doxygen ile gelecekteki uyumluluk hakkında bazı bilgiler? Resmi bir desen geliştirdikten sonra, en azından, Doxygen'e uyum sağlamanın kolay olacağı bir desene bağlı kalmak istiyorum.

Answer 1

Söyleyebileceğim tek şey Core Plot framework

/** @property myProperty 
* @brief Property is very useful 
* Useful and there is a lot more to tell about this property **/ 

gibi bir biçimi kullanarak uygulanmasında mal bildiriminde annotates ve Doxygen kullanarak temiz belgeler üretmek gibi görünüyor olmasıdır. Core Plot documentation policy Gönderen:

@property özellik adı aksi bulamıyorum doxygen olarak gereklidir. salt okunur gibi

Erişimci özellikleri, kopya/korumak/atamak ve nonatomic otomatik olarak eklenir ve belgelerin manuel kısmında oluşmaz gerekir.

Answer 2

Burada Objective-C için kodlama kongre hakkında bazı bilgileri bulabilirsiniz: Google Objective-C Style Guide

Ama istersen, XCode altında belgelerine üretmek için HeaderDoc adlı bir diğer iyi yumuşak yoktur. Burada kendi kodlama stilini kontrol edebilirsiniz: HeaderDoc Tags

Answer 3

Benim deneyim: [SinifAdi]:

Ben yorumların içindeki @property etiketini kullanın

, özelliklerin doxygen çıkışı gibi bozulursa [okumasına, yazmasına, atama].

Ben @property etiketi ommit ve bunun yerine doğru açıklama bloğu altında, kaynak kodunda '@property' beyanı bulma doxygen güvenmek, her şey iyi çalışır. Buna karşılık, @interface arayüzler için iyi çalışır ve protokol için protokole uygun @protocol çalışır. Ayrıca, geçmişte bazı protokol bildirimlerinde doxygen 'slip' vardı. Obj-C hala ikinci sınıf bir dolandırıcılık vatandaşı mı?

Not: Ben GUI Mac'te/Wizard kullanıyorum, ve yorum blokları '!/* *' kullanmak '/ * *' yerine.