The @Precondition Tag


	Resources

	FAQ Online Help File Examples External Links


	Online Help File

	The Time2HELP help file is available online.


	Order Time2HELP

	Order Time2help and pay by credit card, check or bank transfer.

	Order online from Kagi.


	Download trial version

	Download the 30 day trial version of Time2HELP now.


Painless Documentation for your Source Code



		Home Features Download Support News Order

The @Precondition Tag

Syntax

@precondition description

Synonyms

@pre.

Description

Documents a precondition. Applies to methods and routines, and sometimes to properties. A precondition is a statement which is assumed true when the method gets called. It is part of the contract between the caller and callee, with the "burden" on the caller. A good practice is to assert the preconditions of a method.

Example

@pre InputArgument1<>nil
@pre InputArgument2 must be either 1,2 or 3.