code-documentation

I'm currently using JSDoc Toolkit to document my code, but it doesn't quite fit - namely, it seem to struggle with describing namespaces properly. Say you have two simple classes in each their files: lib/database/foo.js : /** @class */ function Foo(...) {...} /** @function ... */ Foo.prototype.init(..., cb) { return cb(null, ...); }; module.exports = foo; And then something inherited lib/database/bar.js : var Foo = require('./foo'); /** * @class * @augments Foo */ function Bar(....) {...} util.inherits(Bar, Foo); Bar.prototype.moreInit(..., cb) { return cb(null, ...); }; In the generated

I am currently developing a Library for Google Apps Script that basically treats a spreadsheet as a database object. Currently, the library has a two identical functions like /** * Opens and creates a query object for a spreadsheet with the given url. * * @param {String} the url of the spreadsheet * @return {SpreadsheetQuery_} a spreadsheet query object for the given spreadsheet */ function openByUrl(url) { return new SpreadsheetQuery_(SpreadsheetApp.openByUrl(url)); } now, for the two public functions, the documentation generated only shows the return type and not the parameter nor the

I´m developing software based on C++ in Xcode and want to have (at least) the same convenience for code documentation as if I was developing for Swift or objc. Example: std::string myString("hello"); if (myString.empty()) { // do something } If I want to know exactly what .empty() does, I would like to Option-Click on the function and get the documentation overlay with information from e.g. http://en.cppreference.com/w/cpp/string/basic_string/empty , exactly as it does for objc and Swift. How is this possible? Current output just looks like this: You cannot. According to Apple's Xcode release

In Visual Studio, how do I change the default XML summary comment snippet from three lines to one line? Currently it provides this snippet when I type /// : /// <summary> /// /// </summary> I would like this shorter snippet: ///<summary></summary> My summaries are often brief and the extra 2 line are unnecessary. Is there a configuration setting for this or some customizable code/custom addon to fix this. This is an older question, but I liked Jason Williams's suggestion of creating a snippet for this, so I did. Not very complicated, but copy-and-paste is even easier :) <?xml version="1.0"

How much code documentation in your .NET source is too much? Some background: I inherited a large codebase that I've talked about in some of the other questions I've posted here on SO. One of the "features" of this codebase is a God Class, a single static class with >3000 lines of code encompassing several dozen static methods. It's everything from Utilities.CalculateFYBasedOnMonth() to Utilities.GetSharePointUserInfo() to Utilities.IsUserIE6() . It's all good code that doesn't need to be rewritten , just refactored into an appropriate set of libraries. I have that planned out. Since these

So this is probably a dumb question, but I have now been searching for quite some time, and I haven't been able to figure out what they do even though I see them often in source-codes. You won't see it in source code, it's probably documentation. It indicates an interactive session, and things typed into the 'interpreter' are marked with this. Output is shown without the arrows. In fact, the python documentation often has a button >>> at the top right of example code to be able to hide the arrows (and output) so that you can copy and paste the code. Shown: Hidden: '>>>' is the prompt of the