[Java] 자바 주석 / 종류

주석 

주석이란 소스코드에 들어있으면서도 소스코드에 영향이 없는 설명문입니다. 

주석을 잘 이용하면 소스코드를 보았을 때 이해를 수월하게 할 수 있습니다. 

Java 주석 종류 

1. 한줄 주석

// 로 작성이 가능합니다.  

import javax.swing.*;
 
public class Dinae{
    Dinae() {
        JFrame jFrame = new JFrame("dinae test");
        JButton jButton = new JButton("file");
        JButton jButton1 = new JButton("file1");
        JButton jButton2 = new JButton("file2");
        JPanel jPanel = new JPanel();
        jPanel.setLayout(new BoxLayout(jPanel, BoxLayout.Y_AXIS));
 
        //jPanel.add(jButton);
        //jPanel.add(jButton1);
        jPanel.add(jButton2);
 
 
        // 감자는 영어로 potato
        jFrame.add(jPanel);
        jFrame.setSize(300, 200);
        jFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        jFrame.setVisible(true);
    }
    public static void main(String[] args) {
        new Dinae();
    }
}

 

 

2. 여러 줄 주석 

/* 로 시작하여 */로 끝납니다. 

/* - */ 안에 있는 텍스트는 주석 처리가 되며 주석을 여러 줄을 할 수도, 한 줄만 할 수도 있습니다.  

import javax.swing.*;
 
public class Dinae{
    Dinae() {
        JFrame jFrame = new JFrame("dinae test");
        JButton jButton = new JButton("file");
        JButton jButton1 = new JButton("file1");
        JButton jButton2 = new JButton("file2");
        JPanel jPanel = new JPanel();
        jPanel.setLayout(new BoxLayout(jPanel, BoxLayout.Y_AXIS));
 
        /*jPanel.add(jButton);
        jPanel.add(jButton1);*/
        jPanel.add(jButton2);
        /*
            아 
        */
 
        /* 감자는 영어로 potato */
        jFrame.add(jPanel);
        jFrame.setSize(300, 200);
        jFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        jFrame.setVisible(true);
    }
    public static void main(String[] args) {
        new Dinae();
    }
}

 

3. 문서 주석 

/** 으로 시작하여 */로 끝납니다. 

JavaDoc을 만들때 사용합니다. 

/** */ 사이 코드들이 주석 처리 됩니다. 

예약어로는 다음등이 있습니다.

@author 개발자 
@exception
@param 
@return
@see 
@serial 
@since 
@throws 
@version 

import javax.swing.*;
 
public class Dinae{
    Dinae() {
        JFrame jFrame = new JFrame("dinae test");
        JButton jButton = new JButton("file");
        JButton jButton1 = new JButton("file1");
        JButton jButton2 = new JButton("file2");
        JPanel jPanel = new JPanel();
        jPanel.setLayout(new BoxLayout(jPanel, BoxLayout.Y_AXIS));
        jPanel.add(jButton);
        jPanel.add(jButton1);
        jPanel.add(jButton2);
        /**
         * @author dinae
         *
         * 하이하이루
         */
 
        jFrame.add(jPanel);
        jFrame.setSize(300, 200);
        jFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        jFrame.setVisible(true);
    }
    public static void main(String[] args) {
        new Dinae();
    }
}