코드 스니핏 (Code Snippet) 이란? 2가지 의미

 

코드 스니핏 이란?

1. 코드 스니핏(Code Snippet)은 글 중간에 삽입되는 짧은 코드 조각을 의미합니다. 이는 특정 기능, 문법, 알고리즘 등의 설명을 직관적으로 전달하기 위해 사용되며, 독자가 코드 흐름을 빠르게 이해할 수 있도록 돕는 도구입니다.

* 개발 지식을 텍스트로만 설명하는 것보다, 코드 스니핏이 함께 있을 때 이해도가 2배 이상 높아진다는 연구도 있습니다

2. 또는 IDE(개발 도구)에서 "자동완성용 코드 템플릿"을 코드 스니핏이라고도 부릅니다.

* 미리 정의된 코드 틀을 간단한 명령어로 빠르게 입력이 가능하고, 오타 방지, 코드 작성 속도 향상, 일관된 스타일 유지 등의 장점이 있습니다.

 

 

1. [문서/블로그/강의]  "예제 코드 조각"

 

개발 블로그 또는 개발 문서에서 쉽게 볼 수 있는 스니핏

제가 생각하는 스니핏은 이렇습니다. 우리가 물건을 볼 때 실제 모습을 보면서 스펙을 글로 읽는거랑, 스펙만으로 물건을 추측하기는 큰 차이가 있습니다. 코드 스니핏이 딱 물건에 상세모습을 보여준다고 생각하면 좋은 것 같습니다. 

어떤 설명과 덧붙여서 코드를 보여주면, 이해하기가 매우 좋은 것이죠 아래 예시를 보여드릴게요

 

예시 1

// javascript 비동기 처리

function fetchData() {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve('데이터 수신 완료');
    }, 1000);
  });
}

fetchData().then(result => console.log(result));
// 출력: 데이터 수신 완료

* 이 코드는 setTimeout을 활용해 1초 후에 데이터를 반환하는 비동기 함수입니다. Promise의 기본 구조를 보여주기 적합한 코드 스니핏

예시 2

// Java Spring Boot 컨트롤러

@RestController
@RequestMapping("/api")
public class HelloController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, Spring!";
    }
}

* 이 코드는 Spring Boot의 Rest API 기본 예제로, 초보자가 @RestController 와 @RequestMapping 개념을 쉽게 익힐 수 있도록 구성된 스니핏

 

위 예시1, 예시2 를 통해서 보듯이 설명보다는 실제 예시를 보는 편이 이해도가 확연히 높아지는 것을 알 수 있습니다. 

---

 

2. IDE (개발도구)  "자동완성용 코드 템플릿"

 

어디에서 사용하지?

• IntelliJ, VSCode 등에서 제공하는 코드 자동완성 기능용 코드 조각

 

미리 정의된 코드 틀을 간단한 명령어(약어)로 빠르게 입력 가능

• IntelliJ IDE 에서 예시

// sout 작성시
System.out.println();

// psvm 작성시
public static void main(String[] args) {}

 

사용 목적

• 오타 방지
• 코드 작성 속도 향상
• 일관된 스타일 유지

 

위와 같이 코드 스니핏이 의미하는 2가지를 설명했습니다.
의미하는 바는 코드 조각이라는 의미는 동일한 것 같습니다.

상황에 따라 코드 스니핏을 잘 활용해야겠네요 ㅎㅎ