Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Spec? For an in-house framework? Luxury!


Did I say Spec? I meant the doxygen output of hundreds of classes with sparse one-line doccumments.

Plus one outdated sequence diagram.


One-line comment? What are you, a writer-librarian?


It can be learned. Observe:

       //! \brief Transport diagnostic wrapper
       class TransportDiagnosticWrapper {
(Actually, meaningful one-line comments are a lyric discipline of their own, related to haikus.)


You joke, but a tool I have seen lauded for being really "smart" at automatically generating doxygen comments does exactly that. I guess it at least saves the time of a human doing it by hand . . .




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: