search

nhnacademy-be6-code-quest / Role

This Team Role
0 stars 0 forks source link

코드 컨벤션 #12

Open gihwanJang opened 5 months ago

gihwanJang commented 5 months ago

Git 컨벤션 문서

Git 컨벤션

1. 브랜치 전략

1.1 브랜치 종류

1.2 브랜치 네이밍 규칙

2. 커밋 메시지 규칙

2.1 커밋 메시지 형식

커밋 메시지는 다음 형식을 따릅니다:

php코드 복사
<타입>: <제목>

<본문>

2.2 타입(Type)

2.3 제목(Subject)

2.4 본문(Body)

커밋 메시지 예시

makefile코드 복사
feat: 사용자 로그인 기능 추가

사용자가 이메일과 비밀번호를 사용하여 로그인할 수 있는 기능을 추가했습니다.
OAuth2를 통한 소셜 로그인 기능도 추가될 예정입니다.

Closes #12

3. Pull Request(PR) 규칙

3.1 PR 제목

3.2 PR 설명

3.3 리뷰어 지정

PR 템플릿 예시

markdown코드 복사
## 변경 사항
- 사용자 로그인 기능 추가

## 테스트 방법
1. `npm install`
2. `npm start`
3. 로그인 페이지에서 이메일과 비밀번호를 입력하여 로그인 테스트

## 관련 이슈
- Closes #12

4. 코드 리뷰 규칙

4.1 코드 리뷰 절차

4.2 리뷰어 책임

코딩 컨벤션 문서

https://www.oracle.com/java/technologies/javase/codeconventions-contents.html

1. 파일 구조

1.1 파일 네이밍

1.2 파일 구조

1.2.1 java 하위

1.2.2 resource 하위

2. 들여쓰기 및 줄 바꿈

2.1 들여쓰기

2.2 줄 길이

2.3 중괄호 스타일

java코드 복사
if (condition) {
    // code
} else {
    // code
}

3. 네이밍 컨벤션

3.1 클래스 및 인터페이스

3.2 메서드 및 변수

3.3 상수

4. 주석

4.1 클래스 및 메서드 주석

java코드 복사
/**
 * 사용자 정보를 가져오는 메서드.
 *
 * @param userId 사용자 ID
 * @return 사용자 정보
 */
public User getUserById(String userId) {
    // implementation
}

4.2 인라인 주석

java코드 복사
int result = calculateSum(a, b); // a와 b의 합을 계산

5. 코드 구조

5.1 메서드 길이

5.2 공백

java코드 복사
public void exampleMethod() {
    int a = 10;
    int b = 20;

    int result = calculateSum(a, b);
    displayResult(result);
}

5.3 임포트 정리

6. 예외 처리

6.1 예외 던지기

java코드 복사
if (user == null) {
    throw new UserNotFoundException("User not found with ID: " + userId);
}

6.2 예외 처리

java코드 복사
try {
    // code that may throw exceptions
} catch (SpecificException e) {
    // handle specific exception
} catch (Exception e) {
    // handle general exception
}

JavaDoc 주석 작성 방법

1. 클래스 및 인터페이스 주석

클래스나 인터페이스 정의 위에 JavaDoc 주석을 작성합니다.

java코드 복사
/**
 * 이 클래스는 사용자 정보를 관리합니다.
 *
 * @version 1.0
 * @author 홍길동
 */
public class User {
    // 클래스 내용
}

2. 메서드 주석

메서드 정의 위에 JavaDoc 주석을 작성합니다.

java코드 복사
/**
 * 주어진 사용자 ID로 사용자를 찾습니다.
 *
 * @param userId 사용자 ID
 * @return 사용자 객체
 * @throws UserNotFoundException 사용자가 없을 때 발생
 */
public User getUserById(String userId) throws UserNotFoundException {
    // 메서드 내용
}

3. 필드 주석

필드 정의 위에 JavaDoc 주석을 작성합니다.

java코드 복사
/**
 * 사용자의 이름을 저장합니다.
 */
private String name;

4. 태그(Tag) 사용

JavaDoc 주석에는 다양한 태그를 사용할 수 있습니다. 주요 태그는 다음과 같습니다:

JavaDoc 문서 생성 방법

JavaDocs를 사용하여 문서를 생성하려면 다음 명령을 사용합니다:

bash코드 복사
javadoc -d [output directory] [source files]

예를 들어, src 폴더에 있는 모든 Java 파일에 대해 문서를 생성하려면:

bash코드 복사
javadoc -d doc src/*.java

이 명령은 src 디렉터리에 있는 모든 Java 파일을 대상으로 JavaDoc을 생성하고, doc 디렉터리에 HTML 파일로 저장합니다.

예제

다음은 간단한 예제입니다.

User.java

java코드 복사
/**
 * 사용자 정보를 저장하는 클래스.
 *
 * @version 1.0
 * @author 홍길동
 */
public class User {

    /**
     * 사용자의 이름.
     */
    private String name;

    /**
     * 사용자 객체를 생성합니다.
     *
     * @param name 사용자 이름
     */
    public User(String name) {
        this.name = name;
    }

    /**
     * 사용자의 이름을 반환합니다.
     *
     * @return 사용자 이름
     */
    public String getName() {
        return name;
    }

    /**
     * 사용자의 이름을 설정합니다.
     *
     * @param name 새로운 사용자 이름
     */
    public void setName(String name) {
        this.name = name;
    }
}

참고 자료

JavaDocs에 대한 공식 문서를 참고하면 더 자세한 정보를 얻을 수 있습니다:

JavaDocs를 잘 활용하면 코드의 이해도를 높이고 유지보수를 용이하게 할 수 있습니다. 문서화는 개발 과정에서 중요한 부분이므로 꾸준히 작성하는 습관을 들이는 것이 좋습니다.

VIRTUKCH commented 5 months ago

깃_메시지.txt 깃_이그노어.txt

24/06/17 -> 깃_이그노어 파일 수정 : .idea 폴더 통째로 안 들어가게 수정했습니다

VIRTUKCH commented 5 months ago

.gitmessage .gitignore

로 바꾸셔서 설정하셔야 합니다!

해당 파일로 바꾸면 숨김 파일로 자동으로 바뀌어서, 일단은 텍스트 파일로 전달해 드렸습니다~!

6.15.21.00 (인준)-

1.파일명 바꾸기

파일명 바꾸는 명령어 (파인더해서 직접하니까 .txt 가 안 떼지는데 떼는 법을 모르겠어서 밑에 명령어 사용했습니다.)

mv 깃_메시지.txt .gitmessage mv 깃_이그노어.txt .gitignore

2.gitmessage 적용

(전 그냥 .gitmessage 파일 추가만 했더니 적용이 안돼서 했습니다. 추가만으로 적용됐다면 안 하셔도 무방합니다) (전 .gitignore는 추가만으로 됐습니다.)

터미널에 pwd 명령어를 입력하면 현재 디렉토리 경로가 나옵니다. .gitmessage 가 위치한 디렉토리에서 해당 명령어 실행해주세요.

그 결과가 Users/username/documents/somewhere라면

git config --global commit.template Users/username/documents/somewhere/.gitmessage

명령어를 실행해주시면 그 위치를 참조해서 커밋 메세지 작성이 가능합니다.

gihwanJang commented 5 months ago

cmd + shift + '.' -> 숨김 파일 보기