documentation

Many database systems don't allow comments or descriptions of tables and fields, so how do you go about documenting the purpose of a table/field apart from the obvious of having good naming conventions? (Let's assume for now that "excellent" table and field names are not enough to document the full meaning of every table, field and relationship in the database.) I know many people use UML diagrams to visualize the database, but I have rarely—if ever—seen a UML diagram including field comments. However, I have good experience with using comments inside .sql files. The downside to this approach

Where is a complete list of the special double-underscore/dunder methods that can be used in classes? (e.g., __init__ , __new__ , __len__ , __add__ ) Please take a look at the special method names section in the Python language reference. Jonny Buchanan Dive Into Python has an excellent appendix for them. If, like me, you want a plain, unadorned list, here it is. I compiled it based on the Python documentation link from the accepted answer. __abs__ __add__ __and__ __call__ __class__ __cmp__ __coerce__ __complex__ __contains__ __del__ __delattr__ __delete__ __delitem__ __delslice__ __dict__ _

Delphi has this list: Delphi Intrinsic Routines But that list is incomplete. Which undocumented intrinsic functions exist, since when and what is their purpose? I know of the following undocumented intrinsic functions. Delphi 2007: here and Hallvard's blog : Default function Default(T: Typeidentifier): value of T; Returns the zero representation of type identifier T . The following intrinsics introduced in XE7 are explained in the XE7 beta blog and by Stefan Glienke IsManagedType function IsManagedType(T: TypeIdentifier): Boolean; True if T is a interface , string or dynamic array , or a

I have a large codebase without Javadoc, and I want to run a program to write a skeleton with the basic Javadoc information (e.g., for each method's parameter write @param...), so I just have to fill the gaps left. Anyone know a good solution for this? Edit: JAutodoc is what I was looking for. It has Ant tasks, an Eclipse plugin, and uses Velocity for the template definition. Laurent K The JAutodoc plugin for eclipse does exactly what you need, but with a package granularity : right click on a package, select "Add javadoc for members..." and the skeleton will be added. There are numerous

I'm trying to get started with Sphinx and seem to have relentless problems. Command: docs/sphinx-quickstart I answer all the questions and everything works fine. Command: docs/ls Everything looks normal. Result: build Makefile source Command: sphinx-build -d build/doctrees source build/html It seems to work. I was able to open the index.html file and see a "shell" of what I'm wanting. When I try and put my actual source code as the source folder I run into problems. Command: sphinx-build -d build/doctrees ../ys_utils build/html Result: Making output directory... Running Sphinx v1.1.3 loading

Does anyone have documentation pertaining to learning the fundamentals of Linux x86-64 assembly? I'm not sure whether or not to learn it as is, or to learn x86 first, and learn it later, but being as I have an x86-64 computer and not an x86, I was thinking of learning x86-64 instead ;) Maybe someone could give me some incentive, and direction as to learning what, how, and with what documentation. Kindly give me your most favoured documentation titles, I code a little Python, this is my first attempt at a lower level language, and I'm more than ready to dedicate to it. Thanks all Callum General

I'm writing a lightweight class whose attributes are intended to be publicly accessible, and only sometimes overridden in specific instantiations. There's no provision in the Python language for creating docstrings for class attributes, or any sort of attributes, for that matter. What is the accepted way, should there be one, to document these attributes? Currently I'm doing this sort of thing: class Albatross(object): """A bird with a flight speed exceeding that of an unladen swallow. Attributes: """ flight_speed = 691 __doc__ += """ flight_speed (691) The maximum speed that such a bird can

Let's face it: You don't need to be a designer to see that default Javadoc looks ugly . There are some resources on the web which offer re-styled Javadoc. But the default behaviour represents the product and should be as reasonably good-looking. Another problem is the fact that the usability of Javadoc is not up-to-date compared to other similar resources. Especially huge projects are hard to navigate using Firefox's quick search. Practical question: Are there any standalone (desktop) applications which are able to browse existing Javadoc in a more usable way than a browser would? I'm thinking