단편(프로그래밍)

Snippet (programming)
코드 스니펫의 예.

스니펫은 재사용 가능한 소스 코드, 기계 코드 또는 텍스트의 작은 영역을 가리키는 프로그래밍 용어입니다.일반적으로 이들은 더 큰 프로그래밍 모듈에 통합하기 위해 공식적으로 정의된 작동 단위입니다.스니펫 관리는 일부 텍스트 편집기, 프로그램 소스 코드 편집기, IDE 및 관련 소프트웨어의 기능입니다.이를 통해 사용자는 일상적인 편집 [1]작업 과정에서 반복 입력을 피할 수 있습니다.

정의.

프로그래밍 실습에서 "스니펫"은 문자 그대로 에디터 프로그램에 의해 파일에 포함된 소스 코드의 일부를 좁게 참조하며 복사 앤 페이스트 프로그래밍의 [2]한 형태입니다.이러한 구체적인 포함은 언어 내의 추상화인 함수나 매크로와 같은 추상화 방법과는 대조적입니다.따라서 스니펫은 추상화가 결여된 언어 또는 명확성과 오버헤드의 부재를 위해 이러한 추상화를 사용할 수 없거나 바람직하지 않은 경우에 주로 사용됩니다.

스니펫은 정적 전처리를 에디터에 포함하는 것과 비슷하며 컴파일러의 지원이 필요하지 않습니다.반대로, 이것은 스니펫이 항상 그 후에 수정될 수 없다는 것을 의미하며, 따라서 복사 앤 페이스트 프로그래밍의 모든 문제에 취약합니다.이러한 이유로 스니펫은 주로 간단한 코드 섹션(논리가 거의 없는) 또는 저작권 고지, 기능 프로토타입, 공통 제어 구조 또는 표준 라이브러리 Import와 같은 보일러 플레이트에 사용됩니다.

개요

스니펫 관리는 반복적으로 입력되는 텍스트 카탈로그(소스 코드나 보일러 플레이트 등)의 콘텐츠를 정기적으로 필요로 하는 소프트웨어 개발자 또는 다른 사람들에게 널리 사용되는 텍스트 편집기 기능입니다.대부분의 경우 이 기능은 입력될 때마다 내용이 약간만(또는 전혀) 다르기 때문에 정당화될 수 있습니다.

텍스트 편집기의 스니펫

일반적으로 이 기능을 포함하는 텍스트 편집기는 카탈로그를 관리하고 텍스트 편집기와 운영 체제가 개별 파일을 관리할 수 있도록 하는 것과 같은 방식으로 "스니펫"을 분리하는 메커니즘을 제공합니다.이러한 기본적인 관리 기능에는 저장소, 카탈로그 또는 데이터베이스에 스니펫 보기, 추가, 편집, 삭제, 정렬, 필터링, 그룹화, 이름 변경 및 저장 등의 작업이 포함됩니다.일부 편집기는 표준 템플릿을 기반으로 함수 프로토타입 및 가변 제어 구조를 생성할 수 있는 스니펫을 작성하는 매크로 기능을 제공합니다.

IDE 스니펫

Eclipse, NetBeans, Microsoft의 Visual Studio(TextMate에서 영감을 받은 스니펫 사용) 등의 일부 프로그래머 응용 프로그램 및 기타 IDE에는 코딩이 용이한 내장 구조 부분이 포함되어 있습니다.

Macromedia Dreamweaver와 같은 다른 응용 프로그램들은 웹 개발에도 이러한 코드 스니펫을 사용합니다.

JIT 컴파일러의 단편

JIT(Just-in-Time) 컴파일러는 미리 컴파일된 코드 섹션을 더 긴 객체 코드/머신 코드 세그먼트로 "스플라이스"할 수 있습니다.이를 통해 해석 시간이 대폭 단축되는 동시에 실행 속도가 향상됩니다.

PowerShell ISE에서의 스니펫 사용을 보여주는 애니메이션 예시

셸 조각

스니펫은 bash, zsh(GNU Linux/Unix 유사) 또는 powershell(MS Windows)과 같은 명령줄 인터페이스 내에서 사용할 수 있습니다.완료 및 플레이스 홀더 대체와 같은 기능은 지원되거나 지원되지 않을 수 있습니다.

예

x와 y 두 변수의 값을 스왑하는 공정을 고려합니다.타이핑이 약하고 이름 충돌에 대해 염려하지 않는 경우, 이것은 코드로 나타납니다.

온도 = x x = y = 온도

스니펫이 삽입되면 프로그래머는 두 파라미터의 값을 입력하도록 요구됩니다.유형이라고 가정합니다.foo그리고.bar이는 스왑할 변수의 실제 이름입니다.이것에 의해, 다음의 코드가 생성됩니다.

temp = foo foo = bar = temp

그 후에 스니펫이 변경되었을 경우는, 「사용한다」라고 합니다.__temp대신temp이미 삽입된 코드는 변경되지 않지만 이후 스니펫 삽입에 사용됩니다.

이를 위한 스니펫은 다음과 같이 나타낼 수 있습니다.

temp = $1 = $2 = temp

관습

스니펫 관리 기능은 앞에서 설명한 기본적인 관리 능력 외에 스니펫과 이를 호스트하는 텍스트 에디터 또는 애플리케이션 간의 인터랙티브 범위에 따라 분류할 수 있다.

이러한 스니펫 기능 그룹에는 다음이 포함됩니다.

  • 일반 텍스트 또는 "정적" 스니펫
  • 인터랙티브 또는 "동적인" 스니펫
  • 스크립트 가능한 스니펫
스태틱
이 유형의 스니펫은 주로 사용자가 현재 문서에 삽입하도록 선택할 수 있는 고정 텍스트로 구성됩니다.사용자는 새로 삽입된 텍스트에 상대적인 커서 위치를 제외하고 다른 항목을 지정할 수 없습니다.스태틱 스니펫은 매크로가 IDE가 아닌 명령줄 프로그램에 의해 평가(또는 삽입)되는 경우가 많다는 점을 제외하면 단순한 매크로와 유사합니다.
역학
스니펫은 편집자 또는 사용자가 수정할 수 있는 동적 요소(플레이스 홀더)와 결합된 고정 텍스트로 구성됩니다.사용자는 현재 문서에 삽입할 항목을 선택할 때 동적 요소의 내용과 고정 텍스트에 대한 위치를 모두 지정할 수 있습니다.동적 요소의 예로는 현재 날짜나 시스템 시각 등의 변수, GUI를 통해 제공되는 사용자로부터의 입력, 다른 응용 프로그램으로부터의 입력 등이 있습니다.(「프로그래머블 매크로」도 참조).
스크립트 가능
스니펫은 매크로 언어 또는 스크립트 언어로 실행 가능한 코드 세그먼트로 구성됩니다.스크립트 가능한 스니펫은 텍스트에디터에 의해 지원되는 프로그래밍 언어, 프로그래밍 언어가 잘 알려져 있는지, 특정 에디터에 고유한지에 따라 다르지만 사용자에게 최대의 유연성을 제공합니다.

스크립팅 지원 유형은 다양하지만 셸 명령어 실행, GUI 대화 상자 또는 운영 체제, 다른 응용 프로그램 또는 호스팅 응용 프로그램 자체의 다른 하위 구성 요소와의 사용자 대화 방법 제공 등의 기능이 포함될 수 있습니다.


스니펫 플레이스 홀더

플레이스 홀더는 사용자 또는 다른 외부 프로세스에 의해 제공되는 스니펫 내의 요소입니다.플레이스 홀더 값은 편집 세션 중에 스니펫의 텍스트를 삽입할 때까지 결정되지 않습니다.

플레이스 홀더는 편집자가 현재 편집 버퍼에 있는 다른 텍스트와 관련된 플레이스 홀더의 경계를 식별할 수 있는 특수한 마크업 구문을 가질 수 있습니다.

다른 응용 프로그램에서는 그래픽 사용자 인터페이스와 사용자가 플레이스 홀더에 제공할 값을 하나 이상 입력할 수 있는 모달 대화 상자를 사용합니다.

자리 표시자 식별자

플레이스 홀더는 보통 특수 문자 또는 문자 시퀀스로 나타나 스니펫 텍스트의 나머지 부분과 구별됩니다.일부 시스템에서는 스니펫 플레이스 홀더에 식별자를 지정할 수 있습니다.식별자는 자리 표시자 복제 또는 자리 표시자 변환과 같은 기능을 지원하는 데 유용할 수 있습니다.

다음 예제에서는 ID를 사용하고 있습니다.first_name,last_name,그리고.item:

안녕{%이름%} {%성_이름%},  고객님의 발송물{%아이템%}이제 받을 준비가 되었습니다.  고마워요.{%이름%}!

TexMate 구문의 스니펫 예:

안녕하세요 ${1:first_name} ${2:last_name}, 이제 ${3:item} 발송물을 픽업할 준비가 되었습니다.${4:first_name} 감사합니다!

자리 표시자 복제

이를 통해 사용자는 한 자리 표시자에 대해 제공된 값이 프로그래밍 가능한 스니펫의 전체 텍스트에 대해 여러 위치에 복제되어야 함을 나타낼 수 있습니다.위의 예에서는 명명된 플레이스홀더first_name에 이 사용 예를 나타냅니다.

자리 표시자 변환

이를 통해 사용자는 플레이스홀더에 대해 제공된 하나 이상의 값을 복제하고 프로그래밍 가능한 스니펫 텍스트 내의 다른 장소에서 변환해야 함을 나타낼 수 있습니다.예를 들어 사용자는 스니펫의 한 부분에 문서 제목을 제공하고 문서 제목을 다른 곳에서 반복하도록 지정할 수 있으며, 첫 번째 인스턴스는 모두 대문자로, 다른 인스턴스는 모두 소문자로 지정할 수 있습니다.

프로그래밍 기능 스니

스크립트 가능한 스니펫을 지원하는 응용 프로그램의 경우 지원되는 프로그래밍 기능의 범위는 다양합니다.다음은 프로그래밍 가능한 스니펫에 대해 일반적으로 구현되는 몇 가지 기능을 나열합니다.

일반 텍스트

일반 텍스트는 프로그래밍 불가능한 "정적" 스니펫만 지원하는 응용 프로그램에도 포함된 기본 기능이지만 프로그래밍 가능한 스니펫은 일반 텍스트 작업에도 사용됩니다.

그러나 프로그래밍 가능한 스니펫을 지원하는 환경에서는 보통 텍스트로 간주되는 것과 프로그래밍 명령으로 간주되는 것을 구분해야 하는 경우가 많습니다.이 구별을 더욱 복잡하게 하는 것은 프로그래밍 가능한 스니펫을 지원하는 어플리케이션이 거의 항상 기본 구문 강조 표시 또는 임베디드 명령 실행을 통해 여러 프로그래밍 언어의 인식을 지원한다는 사실이다.

이러한 이유 및 기타 이유로 프로그래밍 가능한 스니펫에서 플레인텍스트를 내보내려면 구문과 딜리미터의 충돌에 관한 문제를 피하기 위해 거의 항상 주의를 기울여야 합니다.

상수 및 변수

프로그래밍 가능한 스니펫에는 사용자가 다양한 상수 또는 변수를 선택할 수 있는 기존 변수 범위 또는 네임스페이스에 바인딩을 설정하는 기능이 포함되어 있는 경우가 많습니다.여기에는 지정된 시스템에 현재 로그인한 사용자의 전자 메일 주소, 현재 시스템 시간 및 날짜 또는 함수의 출력 값과 같은 값이 포함될 수 있습니다.

스크립트 가능한 스니펫은 현재 하나 이상의 활성 파일과 관련되어 있는 경우가 많습니다.따라서 변수는 현재 편집 세션의 파일과 관련된 다른 통계 정보 중 파일 이름, 커서 위치 및 부모 디렉토리를 지정하는 환경 변수 및 인수를 포함할 수도 있습니다.

해석코드

스크립트 가능한 스니펫을 사용하면 하나 이상의 프로그래밍 언어로 코드를 실행할 수 있습니다.여기에는 하나 이상의 독립 실행형 언어 또는 언어가 호스트되는 응용프로그램에 고유한 언어가 포함될 수 있습니다.

대체 수단

코드 스니펫의 가장 기본적인 대안은 라이브러리의 서브루틴입니다.서브루틴은 재사용 가능한 소프트웨어 라이브러리에 통합되어 여러 프로그래밍 프로젝트 간에 공유할 수 있습니다.

객체 지향 프로그래밍과 기능 프로그래밍의 설계 패턴은 프로그래머가 매번 약간의 변화를 가지고 여러 코드에 반복적으로 스니펫을 삽입하는 것을 피하거나 줄일 수 있는 기술입니다.C 패밀리의 언어에서는 프리프로세서가 이 목적으로 사용되는 경우가 있습니다.

그러나 이 접근법의 단점은 패턴이나 문서를 기억하기 어렵다는 것입니다.

소프트웨어 지원

2021년 현재 사람이 읽을 수 있는 텍스트에서 특정 기능을 추론하고 대응하는 소스 코드 스니펫(예: GitHub Copilot)[3][4]을 생성하는 데 도움이 되는 정교한 딥 러닝 툴이 등장했습니다.

「 」를 참조해 주세요.

무료 사전인 Wiktionary에서 스니펫을 찾아보세요.
  • 자동 완성 – 사용자가 입력하는 단어의 끝을 예측하는 컴퓨팅 기능
  • 코드베이스 – 시스템, 애플리케이션 또는 컴포넌트 구축에 사용되는 소스 코드 컬렉션
  • 코드 리팩터링– 외부 동작을 변경하지 않고 기존 컴퓨터 코드 재구성
  • 콘텐츠 관리 – 대상자를 염두에 두고 구축한 정보 또는 경험을 관리하는 프로세스
  • Pastebin – 사용자가 일반 텍스트를 저장할 수 있는 온라인 콘텐츠 호스팅 서비스 유형
  • 스크랩북(Mac OS)
  • 버전 관리 – 1개 이상의 파일 버전 관리 활동
  • 웹 위젯 – 웹 페이지 내에서 사용하기 위한 애플릿

레퍼런스

  1. ^ "Gedit/Plugins/Snippets". Archived from the original on 2012-08-25. Retrieved 2010-01-09. Gedit Editor 기능의 예시.
  2. ^ Kim, Miryung; Bergman, Lawrence; Lau, Tessa; Notkin, David (2004). "An ethnographic study of copy and paste programming practices in OOPL" (PDF). Proceedings: 2004 International Symposium on Empirical Software Engineering, ISESE 2004: 19–20 August 2004, Redondo Beach, California. Los Alamitos, CA: IEEE. pp. 83–92. ISBN 978-0-7695-2165-7. OCLC 326620442. For each C&P instance, we also noted the relationship between a copied code snippet and code elsewhere in the code base.
  3. ^ H. M. LE, TRIET; CHEN, HAO; ALI BABAR, MUHAMMAD (February 13, 2020). "Deep Learning for Source Code Modeling and Generation: Models, Applications and Challenges" (PDF). The University of Adelaide.{{cite web}}: CS1 maint :url-status (링크)
  4. ^ "GitHub previews new AI tool that makes coding suggestions". TechCrunch. Retrieved 2021-07-25.

코드 스니펫의 예