Is there a code/comment ratio that you consider to be a sign of good (bad) code health? Can you give examples of open source projects that are considered to be well coded and their respective comment ratio? (I realize that no ratio is "true" for every project and there may very well be crappy projects that exhibit this theoretical gold...
There are certain Crystal Reports features that cannot be combined in the same report, for example SQL command objects and server side grouping. However, as far as I can find, the built-in help doesn't seem to clearly document these conflicts. For example, checking the help page for either of those features doesn't mention that it doesn'...
Is there any way to generate project docs during automated builds? I'd like to have a single set of source files (HTML?) with the user manual, and from them generate: PDF document CHM help HTML version of the help The content would be basically the same in all three formats. Currently I'm using msbuild and CCNET, but I could chan...
I've written a fair few php apps in the past, but tonight is my first foray into SVN so I figured I'd also document my code properly. What's the adopted format for documenting php functions? Obviously I could adopt my own format, but, looking forward, if there's one which can be used by documentation tools then all the better. Cheers! ...
I'm looking for a good template on server-side installation of software for a project I'm working on. The client-side is pretty straight-forward. The server-side installation is a little trickier. It is made up of several pieces (services, database connections, dependencies, ports that need to be unblocked etc) During a recent test,...
I am looking for a good primer or technical description of the System Call mechanism that is used by operating systems to transition from user space to the kernel to invoke functions such as "open", "read", "write", etc... Is there anything other than the Wikipedia entry? Websites, pdfs, books, source code, all are welcome :) ...
How do I Configuring DoxyGen to document ActionScript files? I've included the *.as and *.asi files in doxygen's search pattern, but the classes, functions and variables don't show there. ...
Where I work, I'm constantly doing development work. We're usually in a position where we're always busy doing development work with no time to write real maintainer documentation. I doubt my position is unique. My question to everyone is, how do you/your development team handle documentation? Do you document as you go? Do you write do...
Has anyone tried the ActiveRecord Intro Sample with C# 3.5? I somehow have the feeling that the sample is completely wrong or just out of date. The XML configuration is just plain wrong: <add key="connection.connection_string" value="xxx" /> should be : <add key="hibernate.connection.connection_string" value="xxx" /> (if I understa...
I need to create Documentation for a tool (Manually written User Documentation, no Developer/API Documentation from the Source Files). Now, there are about a billion different ways to do it, but I have the following requirements: Needs to be a physical file, so that it can go to SVN Needs to be printable Needs to be readable and search...
Hello. I'm starting with Python coming from java. I was wondering if there exists something similar to JavaDoc API where I can find the class, its methods and and example of how to use it. I've found very helpul to use help( thing ) from the Python ( command line ) I have found this also: http://docs.python.org/ http://docs.python...
I have worked for several companies, but none of them had documentation high on the priority list. So most software lacked documentation, or it was not complete, or it was outdated. So i'm asking you, do you create and maintain (technical) documentation for each project, even if time is an issue. ...
As a consultant, you are sometimes thrown in difficult situations. How is it possible to build a website with a homemade framework which has no documentation? ...
What's a good Wiki (or other browser based collaborative tool) for technical documentation? Both as a programmers reference and more general "How to perform this reoccurring tasks on a computer" documents. I'm looking for Wikis with features specifically geared towards documenting system, framework and application development. I'm not g...
Say that I write an article or document about a certain topic, but the content is meant for readers with certain prior knowledge about the topic. To help people who don't have the "required" background information, I would like to add a note to the top of the page with an explanation and possibly a link to some reference material. Here'...
I'm using very old version of Lotus' Screen cam to record UI manipulation for documentation. What do you use for this purpose? ...
I previously asked about how people organize their online resources and researched data, where one of the suggested tools was using a private wiki. I want to try this out and thus I am looking for a hosted wiki where I can store my thoughts, ideas and project documentation. My requirements are: Must be hosted by a third party. Must ...
After reading about code reviews on the web I started to wonder, are there any sites or communities out there that provide reviews of documentation and technical articles? When working as the only author on a (hobby/open source) project or a (blog) article, I often wish I had someone to read over my work and provide some feedback. This...
Say I'm writing some ruby code and I want to use the standard Date type to get the current date. Instead of using a search engine, is there a faster way to find the documentation for this class? I know I can get the methods for Date by typing Date.methods, but as far as I know this doesn't provide details about argument types or return ...
I was taught to draw diagrams in UML to see the interactions between classes, objects, and participants/the system and so on. However, I've seen several answers here stating the UML is a documentation tool and not a design tool. How do you depict designs graphically if you don't use UML? ...