Re: Attn Dennis

> Tell me, does this inline documentation import imply that you guys
> have standardized your documentation format in your source code? ie
> Everybody is using some standard format?

I'm not using that in Delphi, but in Java it's quite common that people
use a standardized documentation format, in order to be able to use
JavaDoc. IIRC C# also has a (different) standardized documentation
format.

In Java you normally have something like this (dumb example though):

/**
* This function calculates the sine of the specified number.
*
* @param alpha The number to calculate the sine of. Should be
specified
* in radians.
* @return The sine of alpha is returned.
*/
double sine(double alpha)
{
return Math.sin(alpha);
}

The documentation is now associated to this function and it's
parameters and return value. You can have the same thing for a class,
with different tags.

The generated documentation is in HTML format and looks like this:
http://java.sun.com/j2se/1.5.0/docs/api/java/lang/System.html

.

Relevant Pages

  • Re: CPM3 Time and Date stamping, question
    ... documentation is the documentation." ... Is BBC BASIC using the same file format for all ... Any dating system that uses a monotonically incrementing number ... 0000H is *NOT* used by the CP/M date... ...
    (comp.os.cpm)
  • Re: Quick selection of paragraph formats in Microsoft Word
    ... For real time documentations where format is important (e.g., ... because they allow the paragraph formats to be mapped into function keys ... through to make sure I am fully satisfied with my documentation and typing ...
    (microsoft.public.word.docmanagement)
  • Re: Quick selection of paragraph formats in Microsoft Word
    ... Go to Tools> Customize> Keyboard. ... For real time documentations where format is important (e.g., ... through to make sure I am fully satisfied with my documentation and typing ...
    (microsoft.public.word.docmanagement)
  • Re: Read text file to Temp file and apply formating and color chan
    ... relevant data, as I am unsure how to do that being new to C#. ... Your data appears to have a fairly regular format. ... your first step is to review the MSDN documentation ... version 1.6" in the MSDN library". ...
    (microsoft.public.dotnet.languages.csharp)
  • Re: Read text file to Temp file and apply formating and color chan
    ... As I said in my post, your sample code should auto-generate some relevant data. ... My best suggestion is that when a specific property or method in a class is mentioned to you, your first step is to review the MSDN documentation for that property or method. ... On that page, there is this comment: "For the RTF codes, see "rich text format Specification, version 1.6" in the MSDN library". ...
    (microsoft.public.dotnet.languages.csharp)