ROBODoc - ROBODoc

ROBODoc benzer bir dokümantasyon aracı Javadoc ve altında lisanslı GPL . API belgelerini kaynak koddan çıkarmak için kullanılır . Özel olarak biçimlendirilmiş başlıkları çıkararak yorumları ve çalışmaları destekleyen herhangi bir dil ile kullanılabilir. Bunlar daha sonra HTML , DocBook , TROFF , ASCII , LaTeX , PDF veya RTF olarak yeniden biçimlendirilir .

Sınıflar, işlevler, testler, makefile girişleri vb. Gibi herhangi bir programlama yapıtını belgelemek için kullanılabilir.

ROBODoc, C , C ++ , Fortran , Perl , kabuk komut dosyaları , Assembler , DCL , DB / C , Tcl / Tk , Forth , Lisp , COBOL , Occam , Basic , HTML , Clarion ve yorumları destekleyen diğer dillerle çalışır.

Tarih

RoboDok ilk sürümü üzerinde sunulmuştu Autodocs programı esinlenerek 1995 RoboDok içinde Jacco van Weert tarafından yazılmıştır Amiga . Autodocs yalnızca ASCII çıktısı üretti . Jacco, Amigaguide formatında çıktı oluşturan bir versiyon yarattı . Bu, çeşitli dokümantasyon bölümleri arasında köprüler oluşturmayı mümkün kıldı.

Misal

Tipik bir ROBODoc başlığı

  /****f* Robodoc/RB_Panic [2.0d]
   * SYNOPSIS
   */
   
   void RB_Panic (char* cause, char *add_info)
   
  /*
   * FUNCTION
   *   Prints an error message.
   *   Frees all resources used by robodoc.
   *   Terminates program.
   * INPUTS
   *   * cause    - pointer to a string which describes the
   *                cause of the error.
   *   * add_info - pointer to a string with additional information.
   * SEE ALSO
   *   RB_Close_The_Shop ()
   * SOURCE
   */
    {
      printf ("Robodoc: Error, %s\n",cause) ;
      printf ("         %s\n", add_info) ;
      printf ("Robodoc: Panic Fatal error, closing down..\n") ;
      RB_Close_The_Shop () ; /* Free All Resources */
      exit(100) ;
    }
    
   /*******/

ve ortaya çıkan çıktı

Ayrıca bakınız

• Dokümantasyon oluşturucuların karşılaştırılması

Dış bağlantılar

• ROBODoc Ana Sayfası
• ROBODoc git deposu
• SourceForge üzerinde ROBODoc
• Gambas2 ve Gambas3 için belge oluşturucu: RoboDoc için Ön Uç

Bu programlama aracı ile ilgili makale bir taslaktır . Wikipedia'yı genişleterek yardım edebilirsiniz . v t e