SORU
9 EYLÜL 2008, Salı


En iyi İpuçları kodu belgelemek için doxygen kullanarak?

Benim takım bizim C kodu doxygen kullanarak, kamu API bizim başlıkları dikkate belge başlıyor. Harika doxygen esneklik ve farklı özel komutlar, bir sürü var gibi gözüküyor, ama iyi bir şey ve deneme yanılma olmadan kötü bir şey ne olduğu belli değil.

Senin ne kodunuz, işaretlemek için favori yollar DOs ve Fakirler ne YAPMAK GEREKİR?< / ^ br . Lütfen top ipuçları vermektedir oylama kolaylaştırmak için başına bir cevap.

API belgeleri, takımın geri kalanı başlamak için bir şablon sağlamak da dahil olmak üzere bütün yaklaşımımız tanımlamak için arıyorum. Şimdiye kadar böyle bir şey var:

/**
 * @file   example_action.h
 * @Author Me (me@example.com)
 * @date   September, 2008
 * @brief  Brief description of file.
 *
 * Detailed description of file.
 */

/**
 * @name    Example API Actions
 * @brief   Example actions available.
 * @ingroup example
 *
 * This API provides certain actions as an example.
 *
 * @param [in] repeat  Number of times to do nothing.
 *
 * @retval TRUE   Successfully did nothing.
 * @retval FALSE  Oops, did something.
 *
 * Example Usage:
 * @code
 *    example_nada(3); // Do nothing 3 times.
 * @endcode
 */
boolean example(int repeat);

CEVAP
14 Ocak 2009, ÇARŞAMBA


descriptive home page @kullanarak bir Anasayfa (ayrı bir başlık dosyası içinde sadece bu amaç için) yazın. Ana sınıfları, fonksiyonları ve modülleri/benim örnekte, bir rehber yapma gösterildiği gibi düşünün.

Başka Bir Örnek

Yeniden çevrimiçi yukarıda bağlantılı ana oofile doxygen içeriği alıyordum buna rağmen, burada bazı geçerli istemci iş fiyat indirme biçimini kullanarak bir örnek. Kullanarak harika readme.md tipik dosya açık kaynak kodlu projeler dahil fiyat indirimi için bir Anasayfa (Doxygen ayarları) başvurabilirsiniz fiyat indirimi.

Lingopal
========
Developer Documentation started when Andy Dent took over support in May 2014. 

There are a number of pages in Markdown format which explain key aspects:

- @ref doc/LingopalBuilding.md
- @ref doc/LingopalSigning.md
- @ref doc/LingopalDatabases.md
- @ref doc/LingopalExternals.md

See the <a href="pages.html">Related Pages list for more.</a>

-------------

_Note_

These pages, whilst readable by themselves, are designed to be run through the [Doxygen](http://www.doxygen.com) code documentation engine which builds an entire local cross-referenced set of docs. It uses a minor [extension of Markdown formatting.](http://www.stack.nl/~dimitri/doxygen/manual/markdown.html)

The settings to generate the documentation are `Lingopal.doxy` and `LingopalDocOnly.doxy`. The latter is used for quick re-generation of just these additional pages.

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • Canal de arkyoru

    Canal de ark

    18 Ocak 2007
  • ELawshea

    ELawshea

    26 Mayıs 2008
  • Subscribe!!

    Subscribe!!

    3 EKİM 2009