문서화의 힘

이 블로그에서는 문서가 없는 작업에 대한 나쁜 경험과 이를 극복한 방법을 공유하고 싶습니다.

독학으로 학습한 개발자로서 저는 항상 컴퓨터에 뛰어들어 코딩을 시작하는 데 흥미를 느꼈습니다. 그것은 비생산적이기 때문에 거의 나쁜 습관입니다. 저는 어려운 방법을 찾았습니다.

저는 웹 개발 회사에서 정규직으로 일하기 때문에 한 프로젝트에서 다른 프로젝트로 종종 전환하면서 계속 함께 작업하는 수많은 고객 목록이 있습니다.

새로운 개발자로서 저는 단지 학습을 위해 빠르게 코드로 뛰어드는 제 자신을 발견했습니다. 예를 들어, 새로운 문제가 발생하면 연구를 하고 최상의 코드를 찾아 방탄하고 전달합니다. 그러나 나는 항상 문서화를 막았고, 그것이 반응이나 PHP와 같은 대규모 프로그래머를 위한 것일 수도 있고 많은 사람들이 사용하는 것일 수도 있다고 생각했습니다. 곧 나는 내가 틀렸다는 것을 알게 되었다.

연구와 비판적 사고로 문제를 해결하는 것이 중요하듯이 계속해서 구글링을 하거나 비슷한 것을 연구해야 할 때 그 자체로 문제가 되기 시작합니다. 적절한 문서를 통해 이러한 비생산성을 줄이는 데 도움이 되었습니다.

DOCBLOCKS를 사용하여 내 코드 표시

내가 현재 수행하는 가장 생산적인 문서화 형식 중 하나는 기능 위에 문서 블록을 만들고 쉽게 검색할 수 있도록 코드에 주석을 추가하는 것입니다. 가장 중요한 것은 변경 로그입니다.

/**
* This function does something and returns boolean
* @params $anything String
* @author deepyes02
* @return boolean
*
function do_something($anything){
// code
return true;
}

코드에서 함수를 문서화하기 위한 docbloc 예제

이렇게 하면 실제로 무엇이든 될 수 있는 키워드 'deepyes02'를 검색할 수 있습니다. 이렇게 하면 다른 사람이 작성한 코드에서 내가 작성한 함수를 찾는 데 도움이 됩니다. 예를 들어, 다른 사람이 만든 웹사이트에 내 기여가 필요합니다. 분명히 추적하기 쉽고 스크롤하는 대신 많은 시간을 절약할 수 있습니다.

코드 릴리스에서 변경된 내용을 추적하는 변경 로그

더 자세히 볼 수 있는 git이 있긴 하지만 저는 제가 작업하는 각 프로젝트에서 변경 로그 파일을 사용하기 시작했습니다. 거기에 없으면 변경 로그 파일(확장자 없음)을 만들고 리포지토리에 푸시합니다.

##################################################
8-15-2022 - made all countries flag visible by default
1.  added flag for Japan:
\xyz\assets\images\flags
2.  edited logic to render all country flag and not just some. wp-\xyz\functions.php -> function get_network_sites() : line 258
3.  Sitemap issue fix in server. 
#######################################################

코드에서 업데이트를 추적하기 위한 변경 로그.

변경 로그에서 코드 푸시 날짜와 코드 변경 사항을 언급합니다. 이렇게 하면 무엇이 변경되었는지 파악하고 프로젝트에 대해 더 잘 이해할 수 있습니다.

이제 솔직히 코딩에 필요한 이러한 추가 노력은 더 중요한 프로그래밍의 기초를 배우기 위해 고군분투할 때 확실히 더 많이 들립니다.

그러나 기술을 습득하기 시작했고 생산성을 높일 수 있는 선택의 기로에 서게 되면 확실히 도움이 됩니다.

결국, 도구 상자가 없는 프로그래머는 무엇입니까?