2013-07-30 12 views
13

Stavo usando Qt Creator e ho deciso che volevo documentare una funzione che avevo scritto così ho posizionato il mio cursore sopra la mia definizione di funzione e digitato /**<ENTER> in questo modo:Utilizzo della documentazione automatica della mia funzione con Qt Creator?

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

Qt Creator auto-espansione quel commento:

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

Che cos'è questo? Dove è documentato?

Posso usare questo per generare i miei file di aiuto Qt Assistant qch o qualcosa del genere?

risposta

24

Va documentata here o here, ma la sua non ...

Quindi, ecco alcune informazioni su di esso:

Le impostazioni per questa funzione si trovano qui:

di Windows:

Qt Creator> Strumenti> Opzioni> Editor di testo> Completamento> Documentazione Commenti

Mac OS X:

Qt Creator> Preferenze> Editor di testo> Completamento> Documentazione Commenti

Le tre opzioni elenca sono:

  • Abilita blocchi Doxygen
  • Genera breve descrizione
  • Aggiungi asterischi principali

(trovato in Qt 2.6, ma forse nelle versioni precedenti, troppo ?, o può essere parte del plugin di default impostata a un certo punto.)

Lo stub creati sono Doxygen mozziconi di stile.

È possibile utilizzare doxygen per scorrere il codice sorgente e creare una documentazione di fantasia, sia in un file chm che in un documento html e in pdf.

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

http://www.stack.nl/~dimitri/doxygen/manual/output.html (include file Qch)

Ecco un plugin correlato per Qt Creator:

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

E utilizzando il QHelpEngine nel proprio programma di ...

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

E, infine, è possibile utilizzare QDesktopServices per gestire un aiuto url stile:

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

Speranza che aiuta.

+2

Sapete, la documentazione Qt di solito è formidabile, ma ci sono questi casi limite come questo (e l'uso di fogli di stile, per me) in cui non ho idea di come trovare la documentazione giusta per una funzionalità, se esiste. Grazie per informazioni così dettagliate. –

+0

Nessun problema. La roba di QStyleSheets richiede alcune prove ed errori, ma non è molto diversa dal comportamento CSS. Se hai problemi con QStyleSheets, modificherei e caricarne uno diverso al volo. Ecco la cosa più avanzata che ho fatto con i fogli di stile: http://stackoverflow.com/questions/13564823/qlist-out-of-memory/13568733#13568733 Buona fortuna. – phyatt

+0

'Abilita i blocchi Doxygen 'non sai cosa fa? Dovrebbe autocompletare i tag doxygen? Non mostra niente per me - nessun completamento automatico. Qualche idea? –

Problemi correlati