C/C++ documentation

This is a discussion on C/C++ documentation within the C Programming forums, part of the General Programming Boards category; Hello all, I am trying to decide upon a systematic coding standard/documentation for my code. I saw couple of documents ...

  1. #1
    Registered User
    Join Date
    Jun 2004
    Posts
    23

    C/C++ documentation

    Hello all,
    I am trying to decide upon a systematic coding standard/documentation for my code. I saw couple of documents online with different methods of documenting (especially naming style of variable, arrays, functions etc. ).

    http://www.chris-lott.org/resources/cstyle/

    In my lab we have matlab C and C++ developers and I would like to have a generic style useful for all.

    Please suggest which coding standard should I follow


    I found the article "Matlab programming style guidelines" by Richard Johnson very intersting . This is based on Todd Hoff C++ coding standard.

    If I have missed this in FAQ of the forum my apologies. Please direct me there and I will look at it.

    Thanks in advance.

    Nipun

  2. #2
    Linker.exe64
    Join Date
    Mar 2005
    Location
    Croatia,Pozega
    Posts
    37
    Most of companies have their own style. They mix styles found on the web into new style.
    You could do that too. Just remember to write .doc / .htm manual about your coding style.
    Code:
     
     .J?+.                             ?`+.
       .+1P .++.                         ,+` 4++.
      .+zq\ .:.?i                      .!`?  .yz+.
      ?zdd ..:.^`J.                   ,!..?...Kyz+	
     .+dXM ..!p^.N.+                 ,,^.a..`.#XO+.
     .zwWM ^`.Mc`JMhJ.             .:JF`JM..^.#WOz`
      jwpMr`..NF.JMMM,!           .JMMF.dJ..`JNWrc
       0Wgb `!B:.MMMMM,:         ,.MMMF.j$.` NHSZ`
        TWMp`.+;`MMMMMM.:       ;.MMMMM.;+``JHW= 
          7Mh,``JMMMM"`          .TMMMMb``.H#"`
    

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Replies: 5
    Last Post: 06-04-2009, 09:18 AM
  2. C++ Documentation Project (wiki, like php.net)
    By Tempest1 in forum C++ Programming
    Replies: 3
    Last Post: 09-28-2005, 02:11 PM
  3. C# Documentation
    By Mephisto_2k in forum C# Programming
    Replies: 1
    Last Post: 05-06-2004, 05:16 PM
  4. Directx SDK Documentation
    By Zoalord in forum Game Programming
    Replies: 4
    Last Post: 05-08-2003, 06:07 AM
  5. Windows.h and other documentation
    By Zlixar in forum C++ Programming
    Replies: 8
    Last Post: 03-04-2003, 04:21 PM

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21