Closed Thread
Results 1 to 7 of 7

Thread: Documentation software

  1. #1
    solartic's Avatar
    solartic is offline Learning Programmer
    Join Date
    Feb 2008
    Posts
    92
    Rep Power
    15

    Documentation software

    Hi peeps

    I was just wondering is there any software that allows the user to highlight a section of a source code and specify the comment related to the highlighted area. commenting would therefore not be shown in the body of the code by default, it would either be displayed on hover over or mouse click in the same text window as the code or in a separate one. this would work similar to hyperlink. for any coding language.

    Have/would u find something of this nature beneficial?

  2. CODECALL Circuit advertisement
    Join Date
    Always
    Posts
    Many

     
  3. #2
    Join Date
    Jul 2006
    Posts
    16,491
    Blog Entries
    75
    Rep Power
    143

    Re: Documentation software

    It may exist, but I wouldn't use it. It would be more likely that there would be a text editor/IDE that would "hide" comments as you suggest, but I suspect most people would not see a lot of value in them. Code folding seems more useful for hiding multi-line comments, to me.
    Programming is a branch of mathematics.
    My CodeCall Blog | My Personal Blog

  4. #3
    solartic's Avatar
    solartic is offline Learning Programmer
    Join Date
    Feb 2008
    Posts
    92
    Rep Power
    15

    Re: Documentation software

    Thanks you very much for your opinion panther, well as mentioned code foldings is very useful, there are a few minor issues that i have with it though.

    but still what i had in mind could be done similar to code folding its just that by default they would be folded and would be unfolded by clicking or hovering a section of the text(this section would have some identifier letting u know that its commented).

    this would almost be similar to what already exist.

    one of the problem i have with the current text folding is that if i want to unfold a section of text i have to move the cursor all the way to the left (well in my editor).

  5. #4
    Join Date
    Jul 2006
    Posts
    16,491
    Blog Entries
    75
    Rep Power
    143

    Re: Documentation software

    I use jEdit, which has both a click to unfold, and a keyboard shortcut. You could probably modify the default C++ configuration to enhance the folding properties to auto-fold multi-line comments.
    Programming is a branch of mathematics.
    My CodeCall Blog | My Personal Blog

  6. #5
    solartic's Avatar
    solartic is offline Learning Programmer
    Join Date
    Feb 2008
    Posts
    92
    Rep Power
    15

    Re: Documentation software

    thanks ill look into that

  7. #6
    PhoenixHax is offline Newbie
    Join Date
    Jun 2009
    Posts
    2
    Rep Power
    0

    Re: Documentation software

    thanks

  8. #7
    ReignInChaos's Avatar
    ReignInChaos is offline Learning Programmer
    Join Date
    Feb 2009
    Location
    NJ
    Posts
    46
    Blog Entries
    5
    Rep Power
    12

    Re: Documentation software

    I'm just curious why anyone would want to eliminate commenting from a source file? I understand it will reduce the amount of line therefore reducing the size of the file, but are you talking about removing it totally or just reducing it?

Closed Thread

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Similar Threads

  1. Xlib documentation
    By ki4jgt in forum Python
    Replies: 1
    Last Post: 04-03-2011, 04:20 AM
  2. Win32 documentation
    By Ninjaboi in forum C and C++
    Replies: 6
    Last Post: 02-06-2011, 07:16 AM
  3. C Language Documentation
    By RhetoricalRuvim in forum C and C++
    Replies: 18
    Last Post: 01-22-2011, 10:35 AM
  4. Code Documentation
    By BlaineSch in forum General Programming
    Replies: 9
    Last Post: 11-14-2009, 08:06 PM
  5. commenting/documentation
    By John in forum C and C++
    Replies: 2
    Last Post: 02-03-2008, 09:17 AM

Tags for this Thread

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts