Declaration Has Javadoc Problems  

 


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 �±׸� ���� �޼ҵ� ������ � �Ⱓ�� ���� �ʽ��ϴ�.