stddoclet?: Design By Contract Support (@inv, @pre, @post)

Name: tb29552 Date: 05/11/98


I wonder if you would consider an enhancement
request to include documentation tags to support
"Design By Contract" - @inv, Class Invariant;
@pre, Precondition; and @post, Postcondition.
Currently, I am using the following convoluted
html syntax to capture the relevant details:

  /**
   * Deposit money.
   <p>
     <font color="Teal">
<strong> Precondition: </strong>
</font>
<strong> [ amount &gt; 0.00 ]; </strong>
<font color="Blue">
       <em><strong> &quot;Amount must be positive.&quot; </strong></em>
</font>
   </p>
   
   <p>
     <font color="Teal">
<strong> Postcondition: </strong>
</font>
       <strong> [ newBalance = oldBalance + amount ]; </strong>
<font color="Blue">
<em><strong> &quot;New balance must be equal to old balance plus amount.&quot; </strong></em>
</font>
   </p>
   * @param amount java.lang.double
   */
  public void deposit( double amount )
  {
    /* Update balance */
    setBalance( amount );

    /* Instruct observable component to notify IObservers to
       pass SBAccountModel as observed and "state" as change code */
    this.observableComponent.notifyIObservers( this, "balance" );
  }
(Review ID: 30092)
======================================================================