Kendi işlevimin otomatik belgelerini Qt Creator ile mi kullanıyorsunuz?

Question

Qt Creator kullanıyordum ve ben bu yüzden yazmıştı benim işlev tanımı yukarıda benim imleci konumlandırılmış ve şöyle /**<ENTER> yazılan bir işlevi belgelemek istedik karar:

/**<ENTER> 
void MyClass::myFunction(int myArg) 
{ 
... 

Qt Creator otomatik olarak genişletilen bu yorum:

/** 
* @brief MyClass::myFunction 
* @param myArg 
*/ 
void MyClass::myFunction(int myArg) 
{ 
... 

Bu nedir? Nerede belgeleniyor?

Kendi Qt Assistant qch yardım dosyalarımı oluşturmak için bunu kullanabilir miyim?

Answer 1

O here belgelenmiş ya here, ama onun değil ...

Yani burada bu konuda bazı bilgiler verilmiştir edilmelidir:

bu özelliğin ayarlarını burada bulunur:

Pencereler:

Qt Oluşturucu> Araçlar> Seçenekler> Metin Düzenleyici> Tamamlama> Belgeler Yorumlar

Mac OS X:

Qt Creator> Tercihler> Metin Düzenleyici> Tamamlama> Belgeler listelediği olan

üç seçenek Yorumlar:

• Doxygen blokları etkinleştirme
• kısa bir açıklama üret
• Ana borularını ekleyiniz

(Qt 2.6 Bulundu ancak muhtemelen önceki sürümlerinde de ?, yoksa bir noktada ayarlanan varsayılan eklenti parçası olabilir.)

oluşturulan taslakları Doxygen stil koçanları vardır.

Doxygen'i kaynak kodunuzda yayınlamak ve hem chm dosyasında hem de html belgesinde ve pdf'de bazı süslü belgeler oluşturmak için kullanabilirsiniz.

http://www.stack.nl/~dimitri/doxygen/

http://www.stack.nl/~dimitri/doxygen/manual/output.html (qCH dosyaları içerir) İşte

ilgili Qt Creator için eklentidir:

http://dev.kofee.org/projects/qtcreator-doxygen/wiki

Ve kendi programında QHelpEngine kullanarak ...

http://qt-project.org/doc/qt-4.8/qthelp-framework.html

Ve son olarak, bir yardım tarz url işlemek için QDesktopServices kullanabilirsiniz: yardımcı

http://doc-snapshot.qt-project.org/4.8/qdesktopservices.html#url-handlers

Umut.