본문 바로가기
[Effective Java] 메소드가 던지는 모든 예외를 문서화하자. [Effective Java] 메소드가 던지는 모든 예외를 문서화하자. - Javadoc 의 @throws 태그를 사용해서 항상 checked 예외는 별도로 선언하고, 각 예외가 발생하는 상황을 정확하게 문서화하자. 메소드가 던지는 예외가 많다고 해서 메소드 명세에 각 예외를 정확하게 선언하지 않고, 그 예외 클래스의 대표적인 슈퍼 클래스만 함축해서 나타내면 안 된다. - unchecked 예외의 문서 내역은 메소드가 성공적으로 실행되기 위한 사전조건(precondition)을 효과적으로 나타낸다. - 인터페이스에 정의된 메소드의 경우 자신이 던질 수 있는 unchecked 예외를 문서화하는 것이 "특히" 중요하다. 그 인터페이스의 보편적 계약 중 일부분이 되며, 인터페이스를 구현하는 여러 구현체들 간의.. 2017. 2. 28.
[Effective Java] 외부에 제공하는 모든 API 요소에 대해 문서화 주석을 넣자. [Effective Java] 외부에 제공하는 모든 API 요소에 대해 문서화 주석을 넣자. - 사용 가능한 API 라면 반드시 문서화해야 한다. 만일 문서화 주석 규칙에 친숙하지 않다면 배워야 한다. - API 를 문서화하려면, 외부에 제공하는 모든 클래스, 인터페이스, 생성자, 메소드, 필드의 선언부 앞에 문서화 주석을 넣어야 한다. 만일 어떤 클래스가 직렬화될 수 있다면 직렬화 형태도 문서화해야 한다. - 문서화 주석이 빠진 API 를 사용하는 것은 실망스럽고 에러가 생길 가능성이 많다. 유지보수 하기 쉬운 코드를 작성하려면 외부에 공개되지 않는 대부분의 클래스, 인터페이스, 생성자, 메소드, 필드에 대해서도 문서화 주석을 작성해야 한다. - 메소드의 문서화 주석에서는 메소드와 클라이언트 사이의 계.. 2017. 1. 23.
[Effective Java] 매개 변수가 유효한지 검사하기. [Effective Java] 매개 변수가 유효한지 검사하기. - 대부분의 메소드와 생성자는 자신들의 매개 변수로 전달될 수 있는 값에 제한을 둔다. 그런 모든 제약은 명확하게 문서화해야 하며, 메소드 몸체 코드의 맨 앞에서 검사하도록 해야 한다. 이것은 에러가 발생한 후 가능한 빨리 검출해야 한다는 일반적 원칙의 특별한 경우이다. 만일 사전 검사에 실패하면 에러의 검출이 불확실하게 되고, 에러가 생긴 소스 코드를 찾기가 더욱 어려워진다. - public 메소드의 경우는 javadoc 의 @throws 태그를 사용해서 매개 변수 값의 제약을 위반했을 때 발생되는 예외를 문서화한다. 일반적으로 IllegalArgumentException, IndexOutOfBoundsException, NullPointe.. 2017. 1. 9.
[Django] 파이썬 웹 프로그래밍 - Django 의 핵심 기능 #1 [Django] 파이썬 웹 프로그래밍 - Django 의 핵심 기능 #1 -책을 읽으며 Remind 하는 내용, 핵심 내용, 모르던 내용을 정리한 것입니다. 예문 및 자세한 설명은 책을 구매하여 보세요~ * 4.1.1. 데이터 입력 및 수정 * 4.1.2. 필드 순서 변경하기 -테이블 데이터 변경이 아닌 테이블을 보여주는 UI 양식 변경은 admin.py 파일을 변경하면 된다.아래와 같이 순서에 대해 정의하는 admin.ModelAdmin 을 상속하는 녀석을 만들고, register 할 때 이 class 를 함께 전달하면 된다. class QuestionAdmin(admin.ModelAdmin): fields = [‘pub_date’, ‘qestion_text’].. 2016. 12. 13.
[Effective Java] 태그(tagged) 클래스보다는 클래스 계층을 사용하자. [Effective Java] 태그(tagged) 클래스보다는 클래스 계층을 사용하자. - 인스턴스들이 두 개 이상의 특성으로 분류되고 그런 특성을 나타내는 태그(tag) 필드를 갖는 클래스들을 태그 클래스라고 한다. 예를 들어 Figure 라는 class 가 있는데, 생성자의 종류에 따라 Rectangle 도 되었다가 Circle 도 될 수 있는 녀석. 한 Class 가 조건에 따라 많이 다른 특성의 class 의 형태로 변하는 녀석을 말한다. - 태그 클래스(Tagged class) 는 단점 투성이다. enum 선언, 태그 필드, switch, if 문 등을 포함해서 각종 복잡한 코드로 가독성을 떨어뜨린다. 다른 종류의 인스턴스에 속하는 부적절한 필드를 인스턴스가 가지고 있어 필요 없는 메모리 할당과.. 2016. 11. 14.
옷에 있는 세탁 기호 태그 읽는 방법 옷에 있는 세탁 기호 태그 읽는 방법 #세탁 태그 표시 방법은 한국식, 미국식, 일본식, 유럽식이 모두 다르다. #오늘 소개하고자 하는 것은 한국식.우리나라와 일본식은 비슷하다. 세탁기 or 손세탁 #세탁기 모양 네모가 있는 것은 세탁기 돌려도 된다는 것. #약 이라고 되어있는것은 "약하게" 세탁하라는 의미. #양동이 모양은 손세탁. #보통의 세제는 염기성을 띈다. ( 양잿물 )중성 세제는 말 그대로 중성을 띄는 세제를 말한다.빨래 비누, 주방 세제, 합성 세제, 울 샴푸, 울 드라이, 울 터치 등이 중성 세제이다. 표백 #염소계 표백제는 락스를 생각하면 되고,산소계 표백제는 일반 세제를 생각하면 된다. 다림질 #다리미 아래 물결 모양이 있는 것은 천을 대고 다림질 하라는 의미. 드라이 #따로 설명 필요.. 2016. 2. 11.
[기초강좌] HTML Styles - CSS - w3schools 번역 [기초강좌] HTML Styles - CSS - w3schools 번역 w3school 의 강좌 내용을 번역한 글입니다. 원문 : http://www.w3schools.com/html/html_css.asp CSS ( Cascading Style Sheets ) 는 HTML element 들을 스타일링 하는 데 사용된다. Styling HTML with CSS CSS 는 HTML 4 와 함께 소개된 것으로, HTML element 들을 더 나은 방법으로 스타일링 하는 데 사용된다. CSS 는 다음과 같은 방법으로 HTML 에 추가될 수 있다.* Inline - style 속성을 이용하여 HTML element 에 표기된다.* Internal - External Style Sheet External Sty.. 2014. 3. 11.
[Tutorial] Introduction of PHP. Introduction of PHP. Tutorial 대신 를 사용하는 것을 SGML 방식이라고 하며, 이 스타일을 사용하려면 config 파일의 short_open_tags 를 활성화시키거나 짧은 스타일 태그를 사용할 수 있도록 PHP 를 컴파일 해야 한다. 이 방식은 대부분의 서버가 지원하지만, 몇몇 서버는 xml 형태의 선언에 영향을 주기 때문에 Off 를 시켜 놓는다. 따라서 특수한 경우 혹은 config 에 확신이 있는 경우가 아니면 사용하지 않는 것이 좋겠다. 형식으로도 사용 가능하다. ASP 방식으로 알려진 도 사용할 수 있는데, 이 역시 config 파일에서 asp_tags 를 활성해놓았어야 사용할 수 있다. 이는 대부분의 서버에서 기본으로 활성화되어 있지 않기 때문에 "가급적" 사용하지 .. 2013. 10. 5.
[SEO] 검색엔진 최적화 가이드 ( 기초 & 필수정보 ) 검색엔진 최적화 ( SEO ) 에 대해 알아보자! SEO 는 Search Engine Optimization 의 약자.굳이 한국말로 풀어 말하자면 검색엔진 최적화이다.내가 쓴 글이 검색엔진의 상단에 위치하도록 최적화하는 과정 및 방법을 이야기한다. 그럼 검색엔진을 최적화 하는 방법에 대해 알아보자. 양질의 컨텐츠를 제공하자. 가장 먼저 남의 글을 copy & paste 한 것이 아닌, 자신이 손수 작성한 것일수록 좋다.다른 사람이 다루지 않은 내용을 다루고, 그 내용이 전문성이 있어 다른 사람들로부터 링크가 될 정도라면 ( 인바운드 ) 그것은 질이 좋은 컨텐츠라 볼 수 있겠다. 질이 좋은 컨텐츠라도 그 양이 너무 부족한 경우도 문제가 될 수 있다. 결론적으로는, 말 그대로 양질의 컨텐츠일 때 검색엔진에 .. 2013. 5. 13.
반응형

티스토리툴바