Declaration Has Javadoc Problems ������ ����Ȯ�� Javadoc ����Ʈ�� �����ϴ� Ŭ������ Ŭ���� ����� �˻��մϴ�.
Declaration Has Javadoc Problems �˻�� ������ Javadoc �ؽ�Ʈ�� ����Ǵ� �Ϳ� ���� 4 ������ ������ �ϴ� ���� �ɼ��� �����ϴ�:
Class
tab
|
Scope
|
None - Ŭ������ ���� �
Javadoc �ּ��� �ʿ����� �ʽ��ϴ�
Public -
Javadoc �ּ��� public Ŭ�������� ���� �ʿ��մϴ�
Package - Javadoc
�ּ��� public Ŭ������ ��Ű�� ���� Ŭ������ ���� �ʿ��մϴ�
|
|
Required tags
|
@author - @author�� �ʿ��մϴ�
@version - @version
�� �ʿ��մϴ�
|
Method
tab
|
Scope
|
None - �޼ҵ带 ���� �
Javadoc �ּ��� �ʿ����� �ʽ��ϴ�
Public -
Javadoc �ּ��� public �޼ҵ常�� ���� �ʿ��մϴ�
Protected -
Javadoc �ּ��� public�� Protected �޼ҵ带 ���� �ʿ��մϴ�
Package - Javadoc
�ּ��� public, Protected, package local �޼ҵ带 ���� �ʿ��մϴ�
Private - Javadoc
�ּ��� for public, protected, package local, private �޼ҵ带 ���� �ʿ��մϴ�
|
|
Required tags
|
@return -
@return �±״� ���� Ÿ���� void ���� �ٸ� �޼ҵ带 ���� �ʿ��մϴ�.
@param -
@param �±״� �� �Ű� ������ ���� �ʿ��մϴ�
@throws �Ǵ� @exception -
@throws �Ǵ� @exception �±״� �޼ҵ� �ñ׳��Ŀ� �������� �Ϳ� ���� ����� �� ���ܸ� ���� �ʿ��մϴ�
|
Field
tab
|
Scope
����
|
None - �ʵ带 ���� �
Javadoc �ּ��� �ʿ����� �ʽ��ϴ�
Public -
Javadoc �ּ��� public �ʵ常�� ���� �ʿ��մϴ�
Protected -
Javadoc �ּ��� public �� protected �ʵ带 ���� �ʿ��մϴ�
Package -
Javadoc �ּ��� public�� Protected, package local fields�� ���� �ʿ��մϴ�
Private -
Javadoc �ּ��� public, protected, package local, private�ʵ带 ���� �ʿ��մϴ�
|
Inner
class
|
Scope
����
|
None - ���� Ŭ������ ���� � Javadoc �ּ��� �ʿ����� �ʽ��ϴ�
Public -
Javadoc �ּ��� public ���� Ŭ�������� ���� �ʿ��մϴ�
Protected -
Javadoc �ּ��� public �� protected ���� Ŭ������ ���� �ʿ��մϴ�
Package -
Javadoc �ּ��� public�� Protected, package local fields�� ���� �ʿ��մϴ�
Private -
Javadoc �ּ��� public, protected, package local, private���� Ŭ������ ���� �ʿ��մϴ�
|
|
���� Declaration
Has Javadoc Problems üũ �ڽ��� ���õǰ� Inspection �� � ������ ã����, Inspection �� ������� Javadoc�� ������ ������ �ִ� ���� �޼ҵ�/Ŭ����/�ʵ带 �����ִ� Javadoc ���� ǥ���մϴ�.
�˻翡 ���� �߰ߵ� ������ ���� � ���� ������ �ַ�ǵ� ���� �ʽ��ϴ�.
���� Ŭ������ ���ʽÿ�:
public class AClass {
/**
*
* @param m_str
* @param m_int
*/
public void myMethod(String m_str, int m_int, MyAdapter myAdapter) {
//some code here
}
}
Inspection �� AClass �� ����ǰ� �� �Ŀ�, ������ �� �����찡 ��Ÿ�� ���Դϴ�.

Inspection �� �� ���� Javadoc �䱸 ������ �������� �ʾҴٶ�� �����մϴ�. Ư��, Ŭ������ � �ʿ��� Javadoc�� ������ �ʽ��ϴ�, �޼ҵ�� missed �±׸� ���� �޼ҵ� ������ � �Ⱓ�� ���� �ʽ��ϴ�.
|