I need to use utf-8 characters in my perl-documentation. If I use: perldoc MyMod.pm I see strange characters. If I use: pod2text MyMod.pm everything is fine. I use Ubuntu/Debian. $ locale LANG=de_DE.UTF-8 LC_CTYPE="de_DE.UTF-8" LC_NUMERIC="de_DE.UTF-8" LC_TIME="de_DE.UTF-8" LC_COLLATE="de_DE.UTF-8" LC_MONETARY="de_DE.UTF-8" LC_ME...
I have a colleague who insists that his code doesn't need comments, it's "self documenting." I've reviewed his code, and while it's clearer than code which I've seen others produce, I still disagree that self-documenting code is as complete and useful as well commented and documented code. Help me understand his point of view. What i...
I'm trying to get my Javascript documentation in order so that my comments can be used by Intellisense), for example displayResults = function(msg, filterParams) { /// <summary> /// Gathers inputs and refreshes the grid and map /// </summary> /// <param name="msg">JSON data returned by GetConcessions ajax call</param> ...
With the release of Visual Studio 2008, Microsoft implemented code-completion and IntelliSense support for JavaScript. Unfortunately the support for JavaScript is shady at best--one of the major hassles being that when referencing external JavaScript files, the developer has to open and close JavaScript files to force Visual Studio to u...
Hi I am in a process of evaluating wikis. Our main purpose is to use it for product documentation for customers and internal use like specifications etc. I have started out with using the Wiki Matrix and have found that the following products suits our needs: Confluence XWiki Clearspace MediaWiki DocuWiki Is there anyone out there th...
I'm looking for a good overview of all the .NET Framework assemblies and their namespaces and how they (are supposed to) work together. The MSDN .NET Framework Reference has a seemingly complete list of all .NET Framework Class Libraries. Of course---being the MSDN after all---this list is at best rated "border line sufficient", descri...
What steps do I need to take to get HTML documentation automatically building via the build step in Visual Studio? I have all the comments in place and the comments.xml file being generated, and Sandcastle installed. I just need to know what to add to the post-build step in order to generate the docs. ...
For work I have to code with an external company's API to deal with their proprietary database solution. Unfortunately the documentation they provide is more of an example guide then proper API docs, so it is very light on nitty gritty details like error codes, method returns, and exceptions. So for instance, a class will have a .GetEr...
I'm trying to find about ALL the possible options that I can set in web.config. Surprisingly, I can't find this at all (i'm expecting it to be somewhere inside msdn.microsoft.com) I know I can technically add "anything" to web.config, what i'm looking for is the things that the .Net Framework "as shipped" uses. In particular, right now...
I am not sure what the best practices are here, but I often see abbreviated variable names especially when the scope is small. So (to use simple Ruby examples) instead of def add_location(name, coordinates), I see things like def add_loc(name, coord)—and I might even see something like def add_loc(n, x, y). I imagine that longer names mi...
Parrot documentation exists, but it is scattered all over the web; what aiming-to-be-comprehensive sites there are, are often incomplete with large sections missing (yes, that was an empty language specification manual outline on the official Parrot wiki) Are there any decent sources of Parrot documentation in one place? Note: other qu...
As developers, what documentation would you require from your managers? 2 lines description good enough? Won't move without a Use-Case diagram? What kind of documentation would you prefer to work with to help you understand the business requirements? ...
I'm required to provide a handover to our content editors for the update corporate website I've just released. Apparently a training session with notes isn't sufficient. Fair enough. So more dreaded documentation looms. After a fairly brief trawl over Google, I'm unable to find any relevant and usable template to use as the basis of ...
Once I was assigned to a project which was about adding couple new features to the existing Java based web application. Because it was a matter of just couple simple features there was no chance for rewrite. Unfortunately, the code base came from a client without any documentation and the code itself wasn't commented too well. The orig...
I'm building a wrapper for DTS around the Microsoft.SqlServer.DTSPkg80 (the RCW generated from DTSPKG80.DLL). Inside the RCW, on the Connection2 interface, the property "UseDSL" is defined. This property is not in the SQL Server Books Online documentation, and googling it just found a bunch of "fix my code" listings where people have se...
I have a COM SDK written in C++ and I'd like to create documentation for my product. I understand that most people will probably not use C++ for integration with this COM component, but many will. Which method is best to describe the API, without losing details that a C++ developer would need to know. ...
Is there an open source or public domain framework that can document shell scripts similar to what JavaDoc produces? I don't need to limit this just to a specific flavor of shell script, ideally I would like a generic framework for documenting API or command line type commands on a web page that is easy to extend or even better is self d...
Hi, Is there any software that manages specification documents? (high level and low level documentation). Something that helps you organize specification titles/numbering, and you can quickly access a document while viewing the table of contents etc. Versioning would also be great! ...
I just realized from an article in CACM that Doxygen works with Java (and several other languages) too. But Java has already the Javadoc tool. Can someone explain what are the pros and cons of either approach? Are they mutually exclusive? Is there a Maven plugin for Doxygen? ...
Hi, I'm looking for a way to share some iPhone SDK source code I have with others. Goals: Share iPhone SDK source code, Objective C written in XCode. I have a good bit of source code I want to share. I'd like for it to be easy. I'd like for it to have syntax highlighting, by this I mean coloring and formatting Ideally it would allow m...