러스트는 코드 작성에 있어 일관성 있는 스타일을 유지하는 것이 중요합니다. 이 가이드는 코드의 가독성과 품질을 향상시키는데 도움이 되는 일반적인 가이드라인을 제시합니다.

목차

1. 들여쓰기
2. 네이밍 규칙
3. 함수 및 메서드 선언
4. 주석
5. 문서화 주석
6. 코드 레이아웃
7. 포맷팅

들여쓰기

러스트 코드에서는 들여쓰기로는 4 스페이스를 사용합니다. 탭 문자는 허용되지 않습니다.

네이밍 규칙

• 스네이크 케이스를 사용하여 변수, 함수, 메서드, 모듈, 패키지, 등의 이름을 짓습니다. 이는 단어들을 모두 소문자로 작성하고 단어 사이를 밑줄로 구분하는 방식입니다.
• 파스칼 케이스는 구조체, 열거형, 트레잇 등에 사용됩니다. 첫 글자가 대문자이며, 단어 사이를 밑줄로 구분하지 않습니다.

let my_variable_name: i32 = 5;
fn my_function_name() {
    // function body
}

struct MyStructName {
    // fields
}

함수 및 메서드 선언

• 함수와 메서드의 인자 타입과 리턴 타입 사이에는 공백을 추가합니다.
• 인자 목록이 길어질 경우 한 줄에 하나씩 작성하고, 마지막 인자 뒤에 쉼표를 추가합니다.

fn my_function(arg1: i32, arg2: &str) -> bool {
    // function body
}

impl MyStruct {
    fn my_method(
        &self,
        long_arg1: i32,
        long_arg2: &str,
    ) -> usize {
        // method body
    }
}

주석

• //로 한 줄 주석을 작성합니다.
• /* */로 여러 줄 주석을 작성할 수 있습니다.

// 이것은 한 줄 주석입니다.

/*
여러 줄
주석 예시
*/

문서화 주석

• Rust Documentation Comments를 참조하여 코드에 문서화 주석을 작성하세요.

코드 레이아웃

• 중괄호 시작 위치는 다음 라인에 위치합니다.

fn main() {
    // code block
}

포맷팅

• 러스트 코드를 포맷팅하기 위해서는 rustfmt 도구를 사용하세요.

러스트 코드를 작성할때 이러한 스타일 가이드를 준수하면 코드의 가독성과 통일성을 유지할 수 있으며, 협업하는 동료 개발자들과의 커뮤니케이션을 원활하게 할 수 있습니다.