Hacker News Reader

lack of code documentation

AlphaCode --> AlphaDocumentation

As in text completions and corrections for software docs? Have been tinkering with this exact concept: https://i.imgur.com/txhgLiy.mp4

C++ programmer here. I have a class that does something, so a header and a source file. I add some words as a primer on why the class exists, and the magic neural net adds comments in the header as to what the member variables are, and what the methods do.

I'd be really curious to see if the output is comprehensible and informative. There's a huge training corpus for this do I'd assume this would work.

Self-documenting code

Not all code can be self-documenting, especially optimized algorithms and complex operations. Comments serve to add requisite context and clarification that code alone cannot provide. Simply regurgitating the obvious in comments is a waste.

yes, agreed. good document is about why, not what.

I do not believe this will work.

1. document should be about why, not what.

2. not all decisions can be revealed in code itself. (for example, adding a delay to workaround a hardware bug.)

3. the biggest part missing from code documentation is the big picture document, not really the code level document. even you know what a class/function is, you don't know how it is used in the entire project, its life cycle, etc.

Reply on news.ycombinator.com