So what do people use for documenting the source code?

-
So what do people use for documenting the source code?

I'm used to Doxygen from C++. I see there is a pas2dox converter but I'm curious if there are better options out there.

I'd like to comment my code in-line, and then generate html documentation (at least) based on this.

Comments

  1. Paul FosterOctober 17, 2013 at 2:49 AM

    Documentation? What's that? Real programmers just read the source :-P

    ReplyDelete
  2. Ilia ChachkhunashviliOctober 17, 2013 at 3:11 AM

    docomatic is good tool but very expencive

    ReplyDelete
  3. Asbjørn HeidOctober 17, 2013 at 3:12 AM

    Heh, yeah there's that.
    I see Documentation Insight is integrated in the IDE and shows the documentation when hovering over symbols, which is nice. However I'll need the Enterprise version to generate HTML documentation...

    ReplyDelete
  4. Paul FosterOctober 17, 2013 at 3:53 AM

    I always used to use Help&Manual - now Help&Doc (I believe) to generate help systems - it was really good because you could output in a large number of formats and produced a decent printed result too.  Highly recommend.

    ReplyDelete
  5. Asbjørn HeidOctober 17, 2013 at 4:10 AM

    Paul Foster Seems nice, but also seems to work the opposite way? I'd like to keep the documentation in the source code, then generate stand-alone docs based on that.

    ReplyDelete
  6. Uwe RaabeOctober 17, 2013 at 4:29 AM

    You really should consider Documentation Insight. Even the Enterprise version is reasonably priced. The IDE integration alone (available already with the free edition) makes a huge difference. I use it together with Help&Manual, but you can even achieve good results without it.

    ReplyDelete
  7. Asbjørn HeidOctober 17, 2013 at 4:42 AM

    Uwe Raabe At this time, 250 EUR a bit steep for a hobby project. Having played with it for a bit now, it does look nice and the integrated IDE help is enough for me to start using it.

    I would buy it in an instant if HTML output had been in the Pro edition. Not sure why they think that's an Enterprise level feature but oh well.

    ReplyDelete
  8. Kenneth CochranOctober 17, 2013 at 4:43 AM

    I like fpdoc's approach. It parses the source but also uses a separate documentation file for comments that would otherwise clutter the source. Too bad there isn't a Delphi port.

    ReplyDelete
  9. Baoquan ZuoOctober 17, 2013 at 6:00 AM

    Kenneth Cochran Documentation Insight 3 will support external documentation. see http://www.devjetsoftware.com/?p=1293

    ReplyDelete
  10. Nick HodgesOctober 17, 2013 at 6:19 AM

    Big Plus One for Documentation Insight.

    ReplyDelete
  11. Baoquan ZuoOctober 17, 2013 at 6:25 AM

    Asbjørn Heid Thanks for your honest feedback about Documentation Insight. May I ask you:
    1) Will it be personal use or company use?
    2) Do you need to distribute html files to others? (Or just need to browse it in Documentation Explorer, which is live)

    ReplyDelete
  12. Asbjørn HeidOctober 17, 2013 at 6:45 AM

    Baoquan Zuo The HTML docs would be for personal use. I'm writing an open-source library in my spare time at home, so would like to have stand-alone documentation.

    I've played with Documentation Insight Express at work today, and so far I like it a lot. The ability to have a panel docked which I can edit directly is great, combined with the "hoover-tips".

    ReplyDelete
  13. Baoquan ZuoOctober 17, 2013 at 7:04 AM

    Asbjørn Heid Thanks for the information. We have donation program (free license) for qualified open source project. You might be interested in this:
    http://www.devjetsoftware.com/?p=1155

    ReplyDelete
  14. Asbjørn HeidOctober 17, 2013 at 7:09 AM

    Baoquan Zuo Ah that sounds great. I'll send an application when the project has been fleshed out a bit more.

    ReplyDelete

Post a Comment