From owner-freebsd-chat@FreeBSD.ORG  Tue Apr 22 17:33:18 2003
Return-Path: <owner-freebsd-chat@FreeBSD.ORG>
Delivered-To: freebsd-chat@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id A188637B401
	for <freebsd-chat@freebsd.org>; Tue, 22 Apr 2003 17:33:18 -0700 (PDT)
Received: from serenity.mcc.ac.uk (serenity.mcc.ac.uk [130.88.200.93])
	by mx1.FreeBSD.org (Postfix) with ESMTP id E79D543FCB
	for <freebsd-chat@freebsd.org>; Tue, 22 Apr 2003 17:33:17 -0700 (PDT)
	(envelope-from jcm@FreeBSD-uk.eu.org)
Received: from dogma.freebsd-uk.eu.org ([130.88.200.97])
	by serenity.mcc.ac.uk with esmtp (Exim 4.14)
	id 1988C0-000CCP-8d; Wed, 23 Apr 2003 01:32:56 +0100
Received: from dogma.freebsd-uk.eu.org (localhost [127.0.0.1])
	h3N0WtPe066995;	Wed, 23 Apr 2003 01:32:55 +0100 (BST)
	(envelope-from jcm@dogma.freebsd-uk.eu.org)
Received: (from jcm@localhost)
	by dogma.freebsd-uk.eu.org (8.12.6/8.12.6/Submit) id h3N0WtOK066994;
	Wed, 23 Apr 2003 01:32:55 +0100 (BST)
Date: Wed, 23 Apr 2003 01:32:54 +0100
From: Jonathon McKitrick <jcm@FreeBSD-uk.eu.org>
To: Colin Percival <colin.percival@wadham.ox.ac.uk>
Message-ID: <20030423003254.GB66803@dogma.freebsd-uk.eu.org>
References: <20030422132906.GB64101@dogma.freebsd-uk.eu.org>
	<5.0.2.1.1.20030422171035.01c5e258@popserver.sfu.ca>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <5.0.2.1.1.20030422171035.01c5e258@popserver.sfu.ca>
User-Agent: Mutt/1.4i
X-Spam-Score: -15.2 (---------------)
X-Scanner: exiscan for exim4 (http://duncanthrax.net/exiscan/)
	*1988C0-000CCP-8d*2G4YkDrUz62*
cc: freebsd-chat@freebsd.org
Subject: Re: Code layout and debugging time
X-BeenThere: freebsd-chat@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Non technical items related to the community
	<freebsd-chat.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-chat>,
	<mailto:freebsd-chat-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-chat>
List-Post: <mailto:freebsd-chat@freebsd.org>
List-Help: <mailto:freebsd-chat-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-chat>,
	<mailto:freebsd-chat-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 23 Apr 2003 00:33:18 -0000

On Tue, Apr 22, 2003 at 05:22:18PM +0100, Colin Percival wrote:
: in heavily commented code; I have a feeling that one might find that 
: writing comments into a distinct "documentation" file would have an 
: advantage over the usual practice of writing comments in the middle of code.

Isn't there something called JavaDoc that follows this idea?


jcm
--
Consulting: If you aren't part of the solution, there is
a lot of money to be made in prolonging the problem.