6개월 뒤에도 쓸모 있는 코드 조각 보관하기

맥락 없는 코드 조각은 추측 과제가 됩니다. 오늘은 왜 저장했는지 기억할 수 있지만 6개월 뒤에는 빠진 입력, 의존성이나 전제가 코드 자체보다 중요할 수 있습니다.

해결책과 함께 문제를 저장하세요

메모에 설명적인 제목을 붙이고 코드 조각이 무엇을 하는지 설명하세요. 언어, 관련 버전과 의존성을 기록하세요. 시험할 때 쓴 최소 입력 예제와 예상한 출력을 포함하세요.

출처에서 가져온 코드라면 링크를 유지하고 재사용 조건을 확인하세요. 짧다는 이유로 출처 표기를 제거하지 마세요. 저장 예제에는 비밀 정보, 실제 고객 데이터와 환경별 인증 정보를 넣지 마세요.

코드가 받는 입력과 받지 않는 입력을 적으세요. 파일을 바꾸는지, 서비스를 호출하는지, 권한이 필요한지 기록하세요. 편리한 단축 명령처럼 보여도 다른 디렉터리에서는 전혀 다른 영향을 줄 수 있습니다.

Markdown 렌더러가 지원하면 언어 표시가 있는 울타리 코드 블록을 쓰세요. MeatPad의 프로젝트 편집기에서는 관련 소스 파일 옆에 메모를 둘 수 있습니다. 구문 강조는 읽기를 돕지만 코드가 올바르다는 것을 입증하지는 않습니다.

사용할 환경에서 작고 중요하지 않은 예제로 코드를 실행하세요. 결과를 저장한 기대값과 비교하세요. 메모를 쓴 뒤 의존성과 API가 바뀔 수 있습니다.

코드 조각이 반복 작업의 일부가 되면 마지막 검증 날짜를 추가하세요. 맥락이 전체 프로그램 규모로 커졌다면 메모에 수정을 쌓기보다 유지 관리되는 스크립트로 발전시키세요. 유용한 코드 조각은 붙여 넣을 수 있는 것이 아니라 설명하고 시험할 수 있는 것입니다.

메모부터 시작하세요. MeatPad는 계정 없이 Mac에서 메모, Markdown과 프로젝트 파일을 위한 로컬 작업 공간을 제공합니다.