[CS 지식] Javadoc, Varchar vs Char, IIS, HTTP(80번 포트), HTTPS(443번 포트)

📝Javadoc

코드를 작성하다 보면 유지보수, 배포 등 다양한 상황으로 인해 코드의 문서 작성이 필요한 경우가 있습니다.

하지만 작성한 코드의 클래스, 필드, 메서드에 대해 개발이 완료된 후 일일이 작성하는 것은 번거로울 뿐더러, 코드의 규모가 크다면 더 복잡한 일이 될 것입니다. 이를 지원하기 위해서 자바에서는 Javadoc을 사용하게 지원해줍니다.

즉, Java에서 지원하는 공식적인 주석 가이드입니다

   

📝Javadoc의 장점

표준에 맞춘 주석 작성으로, 구독자 간의 혼동을 최소화 할 수 있습니다.
코드에 문서를 포함시킬 수 있어 개발과 동시에 쉬운 문서화가 가능합니다.

 

위에 기본적인 javadoc에서 쓰이는 기본 규칙입니다.

 

@method  : 메소드명
@brief   : 함수 or 클래스 설명
@detail  : 함수 or 클래스 상세 설명
@author  : 작성자
@since   : 작성일자
@param   : 인자(매개변수)
@return  : 반환값
@why     : 만든 이유


/**
 * @method  : 
 * @brief   : 
 * @detail  : 
 * @param   : 
 * @return  : String
 * @why     : 
 * ===========================================================
 * DATE              AUTHOR             NOTE
 * -----------------------------------------------------------
 * 2022.05.06        SungJae Lee       최초 생성
*/

 

위에는 제가 따로 찾아서 정리한 저만의 규격입니다 → 요즘 트렌드는 어떤지 잘 모르겠네요 구닥다리 기술일 수도 있음

 

클래스나 매개변수가 없는 등 같은 경우는 인자값이나 매개변수 또는 반환값이 없으니 없는 건 안 적어도 상관없습니다.

 

📝Varchar vs Char  

• Varchar
  • Varchar(20)인 경우 2글자 입력시 2byte 크기 만큼 가변적으로 적용되며 30글자 입력시 그만큼 늘어납니다
• Char
  • Char(20)인 경우 2글자 입력시  20byte 크기 만큼 가지게 되며 30글자 입력시 에러가 발생하게 됩니다

 

📝IIS

윈도우 OS가 지원해주는 서버 개발 프로그램으로 이걸 이용해 서버를 만들거나 호스팅 할 수 있습니다 → ASP 스크립트 언어를 사용해 개발합니다

 

📝HTTP (80번포트)

HTTP 프로토콜로 도메인만 작성하고 포트번호를 따로 주지 않아도 웹브라우저에서는 HTTP 담당 포트인 80번으로 연결됩니다 → http://example.com/

 

📝HTTPS (443번포트)

HTTPS 프로토콜로 도메인만 작성하고 포트번호를 따로 주지 않아도 웹브라우저에서는 HTTPS 담당 포트인 443번으로 연결됩니다 → https://example.com/

 

요즘에는 무조건 HTTPS를 권장하고 HTTPS를 안 쓰면 지원 안 해주는 것도 많습니다 그래서 따로 HTTP 서버를 안 열고 HTTPS로만 운용합니다 참고로 쇼핑몰같이 개인정보가 중요한 곳은 HTTPS로 운용안 하면 벌금을 무지막지하게 받습니다