dmi.java

来自「使用java编写的关于通讯及串口编程所必需的类库」· Java 代码 · 共 29 行

/*
 * IDocumentationMarker.java
 *
 * Created on March 6, 2003, 7:10 PM
 */

package com.adaptiveview.ospso.dmi;

/** This is the top level <b>Documentation Marker Interface</b> (DMI). All DMIs
 * extend this interface. <p>DMIs <I>only contain documentation</I>, typically regarding
 * design choices, contracts, design patterns or overviews that either apply to multiple classes
 * or are of such a general nature that they are not appropriate for inclusion
 * at the level of Class documentation.
 *<p>Classes implement applicable DMIs (zero or more). Due to how JavaDoc (the Standard Doclet) works,
 * these implementations become listed (and hyperlinked) in the API docs as part
 * of the Class documentation. Likewise, the generated API docs for each DMI will
 * list (and hyperlink to) all implementing Classes. It is therefore a trivial
 * matter for one to find, for example, which Classes abide by a certain documented 
 * design contract or, conversely, the documentation for contracts, design choices, etc. 
 * for a particular Class.
 *<center><hr width="50%"</center>
 *<p><b>Credit where credit's due</b>: The DMI concept was presented in a
 * <a href="http://www.developer.com/design/article.php/2106271">developer.com article</a> by <a href="http://www.polyglotinc.com">Bruce Wallace</a>.
 * 
 * @author AdaptiveView.com
 */

public interface DMI {}