개발자로서 나는 어떻게 필기를 처리했는가

최근에 나는 필기를 잘하는 중요성을 깨달았다.

향농게
@ 향농 클라빌

프로젝트/과정의 노트를 언급했는데, 결과적으로 당신의 노트가 매우 나쁘다는 것을 발견했는데, 당신은 싫지 않습니까?
15:2019년 7월 9일 오후 12시
나는 내가 한 적이 한두 번이 아니라는 것을 인정한다.
필기에 대한 나의 태도는 과거에 "만약 내가 기억하지 못한다면, 그것은 틀림없이 그렇게 중요하지 않을 것이다."였다.
에이
스케치와 개념이 보편적이라면 한 예술대학에서 효과가 있을 것이다.그러나 내가 소프트웨어 엔지니어라는 분야에 깊이 들어가면서 특정한 과정을 기억하는 것은 더욱 어려워졌다.
우선 되돌아봐야 할 것은 개념만이 아니다.근데 어떻게 하지?
루비를 사용하고 있습니까, 아니면 자바스크립트를 사용하고 있습니까?수조에서 무작위 항목을 얻는 개념은 두 언어에서 같을 수 있지만 문법은 다르다.출력 결과는 어떻습니까? 어떤 형식을 사용해야 합니까?아니면, 이것은 논점을 설명해야 합니까?
이것은 내가 이전에 한 코드와 유사한 것을 작성할 때 생각한 것들이지만, 나는 내가 어떻게 했는지 기억하지 못한다.
만약 내가 현재 모든 가사가 차지하고 있는 기억 공간을 머릿속에 넣을 수 있다면, 아마도 나는 모든 것을 기억할 수 있을 것이다. 그러나 지금은 더욱 좋은 필기를 꾸준히 할 것이다.
다음은 나에게 효과적인 방법이다.

실제로 코드에 주석을 쓰다

나는 아마도 세계에서 유일하게 미래에 네가 너의 코드가 무엇을 하는지 기억할 것이라고 생각하는 개발자가 아닐 것이다.이것은 단기적으로는 옳을 수 있지만 장기적으로는 (하늘, 주, 시간 등) 다른 일이다.
이 문제를 해결하기 위해서 나는 평론에서 줄마다 코드가 무엇을 하고 있는지 자신에게 설명했다.
다음은 사용 방법의 예시입니다. 이 방법은 매번 randomly generates a new hex color을 실행합니다.

def createColor
# Lists all possible integers that can be use in a valid hex code
  hexadecimalIntegers = ["0","1","2","3","4","5","6","7","8","9","a","b","c","d","e","f"] 

# Randomly get 6 items from the hexadecimalIntegers array, then join them together at each character
color = hexadecimalIntegers.sample(6).join("")

# Puts hex color
  "Your new hex color is ##{color}" 
end

평론을 쓸 때, 나는 다른 사람에게 나의 코드를 어떻게 설명해야 할지 생각하는 것을 좋아한다.나는 .sample 대신 .rand을 사용하는 이유를 설명하기 위해 더 나아가 주석을 추가할 수 있다.

필기

나는 이것이 내가 가고 싶은 노선인지 아닌지를 계속 논쟁하고 있다는 것을 인정한다.나는 처리해야 할 사항에 대한 총알 로그를 가지고 있지만, 한 디지털 문서에서 다른 디지털 문서로 복사하고 붙이는 것이 이렇게 쉬울 때, 수동으로 코드를 작성하는 것은 매우 어리석은 것 같다.
타자가 아닌 pen and paper note-taking을 지지하는 연구가 있어서 한번 해 보기로 했습니다.
루비 수업하면 머리가 기절할 것 같아.이것은 많은 운동 부품이 있는 새로운 개념이다.고급 부분에 들어가기 전에 핵심 개념을 이해했는지 확인하고 싶습니다.
루비 수업을 복습하러 갔을 때, 나는 수업 자료를 다시 읽고 종이와 필기를 했다.내가 잊어버린 관건적인 개념을 발견하면 나는 너희들의 실례 변수를 보고 있다. 나는 모두 쓸 것이다.나의 내연 주석과 유사하게 코드 단편 옆에서 나는 간단한 영어로 함수의 더 큰 범위 내에서의 작용을 소개할 것이다.
손으로 필기를 해서 나로 하여금 필기의 간결함과 집중을 유지하게 했다.이런 주석에 나의 내연 주석을 더하면 재구성에 매우 도움이 된다. 이것은 나의 다음 점을 이끌어 낸다.

자주 검사 및 재구성

너는 일찍이 문제를 해결한 적이 있는데, 그 후에 자신이 실제로 무엇을 했는지 모른다고 느꼈니?
짧은 시간 안에 많은 것을 배우고 싶은 부작용일지도 모른다.그러나 나는 새로운 개념에 들어가기 전에 내가 이전에 쓴 코드, 주석, 평론을 되돌아보는 데 시간을 쓰는 것이 좋겠다는 것을 깨달았다.
이것이 바로 재구성의 용무지이다.
재구성은 나에게 새로운 개념이지만, 나는 그것이 그 기능을 유지하는 동시에 기존 코드를 개선하는 것이라고 생각한다.
통상적으로, 나의 내연 주석은 충분한 이야기를 제공했고, 나는 코드가 해결해야 할 문제를 안다.
그리고 나는 나의 필기를 참고할 수 있다. 그 중에서 더욱 광범위한 개념을 포함하고 내가 어디에서 개선할 수 있는지 볼 수 있다.
예를 들어, 변수 이름을 밝힐 수 있습니까?삭제할 수 있는 여분의 코드가 있습니까?내 코드는 가장자리 상황을 설명해야 합니까?
마지막으로 좋은 필기를 열심히 쓰면 학습 과정의 게임 규칙을 바꿀 수 있다.
비록 서면 필기는 내연 코드 주석을 곁들여 나에게 매우 유용하지만, 중요한 것은 어떤 서면, 입력, 오디오의 필기 형식을 사용하든지 너에게 가장 적합하다는 것이다.
네가 새로운 개념을 배울 때, 너는 어떤 필기 방법을 채택할 거니?
Photo by Kelly Sikkema on Unsplash
처음 내 블로그에 발표: https://shannoncrabill.com/blog/taking-notes-as-a-developer/