Java - 在哪裏指定一個類是做什麼的？

Question

我目前正在研究一個相當大的java項目，而且我有一些小問題需要記住什麼都馬上做了，並且經常不斷地瀏覽課程內容以便準確記住所有事情。是否有任何常規方式來聲明每個類/方法？我正在尋找類似python的方法聲明：

def foo(x): 
''' 
Takes and integer x and adds 1 
''' 
return x + 1 

Answer 1

我強烈要求你學習，練習和編寫Javadoc！

How to Write Doc Comments for the Javadoc Tool

你到處都可以寫的Javadoc，因爲Javadoc是一個註釋。 javadoc工具（或者您的IDE - 例如Netbeans）應該能夠讓您瞭解何時懸停（如果適用）。它也用於生成官方的API文檔。這是一個「文學編程」的例子，這裏是一個官方樣本，即File。

Answer 2

Javadoc註釋用於放置類/方法的描述。 Javadoc評論可以導出爲HTML，以方便閱讀。

關注這個：

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

這裏是javadoc註釋類：

/** 
* A Container is an object that contains other objects. 
* @author Trevor Miller 
* @version 1.2 
* @since 0.3 
*/ 
public abstract class Container { 

    /** 
    * Create an empty container. 
    */ 
    protected Container() { } 

    /** 
    * Return the number of elements contained in this container. 
    * @return The number of objects contained 
    */ 
    public abstract int count(); 

    /** 
    * Clear all elements from this container. 
    * This removes all contained objects. 
    */ 
    public abstract void clear(); 

    /** 
    * Accept the given visitor to visit all objects contained. 
    * @param visitor The visitor to accept 
    */ 
    public abstract void accept(final Visitor visitor); 

    /** 
    * Return an iterator over all objects conatined. 
    * @return An iterator over all objects 
    */ 
    public abstract Iterator iterator(); 

    /** 
    * Determine whether this container is empty or not. 
    * @return <CODE>true</CODE> if the container is empty: 
    * <CODE>count == 0</CODE>, <CODE>false</CODE> 
    * otherwise 
    */ 
    public boolean isEmpty() { 
     return (this.count() == 0); 
    } 

    /** 
    * Determine whether this container is full. 
    * @return <CODE>true</CODE> if conatiner is full, 
    * <CODE>false</CODE> otherwise 
    */ 
    public boolean isFull() { 
     return false; 
    } 

} 

Answer 3

利用現有結構間的。評論您的代碼以支持JavaDoc符號。

大多數現代IDE都能夠解析JavaDoc並將它們作爲彈出窗口提供給您。

這也意味着您可以在稍後階段生成JavaDoc文檔。

更多細節退房How to Write Doc Comments for the Javadoc Tool