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了解详情