Personally, I feel that it is. Documentation is often the most useful to future developers maintaining your software – especially member documentation. Even public API documentation is only of limited use to any audience other than a developer. Document for those following – they will thank you.
A couple of ideas considering your recent edits, although I agree it is a bit shooting in the dark… I would use a tool like “Beyond Compare” to compare the .Net Framework files and XML files on both machines (“folder compare” profile). Favour the binary level comparison to be perfectly sure… if both of your … Read more
Dash http://kapeli.com/dash includes offline documentation for 150+ APIs.
I have gotten it to work as follows: Use XML style comments for your C++/CLI header entries. This means the full XML comment is required (triple-slash comments, <summary> tag at a minimum) Make sure that the C++ compiler option Generate XML Documentation Files is on. This should generate an XML file with documentation with the … Read more
Before you look at the code: Clear the objs and the exes, and let him/her rebuild the thing. Watch for any manual interaction (does it build via “make” alone or is there some fiddling involved). Better yet: give him/her a naked (just bought) machine, let him/her demonstrate a checkout and rebuild. Then see how the … Read more
JSDoc is a port of JavaDoc. So basically the documentation assumes classical OOP and that’s not suited to JavaScript. Personally I would recommend using docco to annotate your source code. Examples of it can be found for underscore, backbone, docco. A good alternative to docco is groc As for an actual API documentation, I personally … Read more
[Update: Aug 2017. Adapted to the full Go rewrite of protoc-gen-bug, currently 1.0.0-rc] The protoc-doc-gen, created by @estan (see also his earlier answer) provides a good and easy way to generate your documentation in html, json, markdown, pdf and other formats. There are number of additional things that I should mention: estan is no longer … Read more
Parameters that work both via the command line utility and Xcode: –base-class: The name af the base class which the “private class” (e.g. _MyObject.h) will inherit from. This will also add an import in the form of #import “MyManagedObject.h” to the same .h file. Tip: if the class you want to inherit from is located … Read more
I know of three main languages used commonly in the greater programming and tech community: Textile, Markdown, and reStructuredText. All three can be learned in a couple of hours or “winged” with the cheat sheet nearby. Textile Used by Redmine and the Ruby community 113 questions currently tagged on Stack Overflow The most similar to … Read more
I like to make use of the fact that names can be documented in multiple places. In the header file, I write a brief description of the method, and document all its parameters – these are less likely to change than the implementation of the method itself, and if they do, then the function prototype … Read more