Menu

Code documentation guidelines

1999-12-04
1999-12-06
  • Thomas Maguire

    Thomas Maguire - 1999-12-04

    I didn't see any approach/guideline for source documentation.  Did I miss it?

     
    • Frank V. Castellucci

      You are quite right. That is an issue that should be solved. There is Doc++ for Linux, there are also others that should be looked at.

      The most advantageous would be one that doesn't require any special tagging, although the capability to generate useful documentation (class browse, hierarchy, html format, etc) seems to require some tagging.

      Thoughts?

       
      • Thomas Maguire

        Thomas Maguire - 1999-12-06

        Personally I like Doc++; it has some tagging but the tagging isn't necessary for straight forward class and member documentation.  I haven't surveyed the landsacpe though I'm not sure what is out there that is newer.

         
        • Frank V. Castellucci

          I added it to the requirements. Take a look at the mailing list. This is a way to open communications from e-mail instead of going through here every time.

           

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.