[오답 대응] 잠정 대응 코드를 적어서 하고 싶은 거.

프로그램의 오류가 발생했을 때, 나는 우선 피하는 코드를 쓸 것이라고 생각한다.
이번에 나는 이른바 잠정적 대응 코드를 쓴 상태에서 하고 싶은 일을 썼다.
예를 들어, Function A입니다.자바의 도 () 방법에서 자주 발생하는 원인 불명의 오류에 대해 일시적으로 대응하기 위해 "this.temp ()"방법을 추가했습니다.
FunctionA.java

・・（これより上既存のコード）
this.temp();
・・（これより下既存のコード）

이렇게 되면 뒤에서 보는 사람이 무슨 일인지 몰라져서 댓글을 달게 된다.

작업 관리 도구를 사용하는 경우

백로그와 레드마인 등 미션 관리 도구를 사용한 경우 티켓을 제작해 댓글에 티켓 번호와 제목만 기재하고 자세한 내용은 저쪽에 적어주세요.
예를 들어 입장권 번호가'hoge-123'이고 제목이'일시적으로 오류를 피한다'는 경우 다음과 같다.
FunctionA.java

・・（これより上既存のコード）
// hoge-123：機能Aのdoメソッドで発生するエラーへの暫定対応
this.temp();
・・（これより下既存のコード）

표를 대조하다

발생 사건

대응 내용

향후 과제

나중에 보는 사람에게 알리다.
예를 들면 아래의 느낌.

작업 관리 도구를 사용하지 않은 경우

프로젝트에 따라 임무 관리 도구를 사용하지 않는 경우도 있다.
나도 그 상황의 대체 방안을 고려했다.

1. 해당 폴더 작성 및 필기

대안 중의 하나.
아래와 같이 응용 폴더에 대해 잠정적으로 설정하고 파일 이름에 제목을 기재하며 그 중에서 발생 사건, 대응 내용, 향후 과제를 기재한다.

2. 디자인북에 눈에 띄게 작성

대안 2.
디자인북에 불어서 거기에 대응하는 내용을 기재하거나 대상이 처리한 곳의 색깔을 바꾸어 근처에 댓글을 남겨도 된다.

NG의 예

1. 댓글을 달지 않는다

가까스로 임시로 대응하는 코드를 썼는데 평론이 없으면 안 된다.
나중에 본 사람은 이 코드를 무엇으로 이해합니까?이 일은 조사가 일어나기 때문에 예상치 못한 시간을 차지할 수도 있다.

2. 댓글이 너무 짧거나 길다

댓글을 안 쓰는 게 낫지만 댓글이 너무 짧거나 길어도 NG를 낸다.

댓글이 너무 짧은 타입.

FunctionA.java

・・（これより上既存のコード）
// 機能Aのdoメソッドで発生するエラーへの暫定対応
this.temp();
・・（これより下既存のコード）

상술한 것은 지금까지의 예의 제목 부분만 기재한 상황이다.
모르는 것도 아니고 좀 더 구체적인 내용을 원했을 뿐이다.

주석이 너무 긴 모드

FunctionA.java

・・（これより上既存のコード）
/* 機能Aのdoメソッドで発生するエラーへの暫定対応
 * 発生事象:機能Aで5%程度の確率でエラー画面に遷移する事象が発生
 * 対応内容:回避用のtemp()メソッドを作成＆使用
 * 今後の課題:直接の原因を突き止め、対処する
 */
this.temp();
・・（これより下既存のコード）

이것은 어떤 문서입니까?이런 수평 길이.
코드의 가독성도 곧 방해될 것이다.
역시 댓글을 달고 자세한 내용은 다른 곳에 쓰는 게 좋다.

가장 중요한 일

이로써 잠정적 대응 코드를 썼다면 코드에 주석을 달고 자세한 내용은 다른 곳에 쓰는 것이 좋다.
그러나 무엇보다 이런 대응을 할 때 어떻게 기록을 남기고 팀 내에서 규칙을 통일하느냐가 중요하다.
어떤 사람은 티켓에 상세히 기재하고, 어떤 사람은 어디에 기록을 남기는지 나중에 처리하는 사람은 곤란하겠죠.
오류발생♥잠정대응코드를 쓰려면팀내의규칙을먼저확인해야하고없으면어떻게해야할지상의해야한다!

끝맺다

실수 대응에 긴급히 대처해야 하는 경우도 많아 상당한 에너지가 소모됐지만 훗날을 염두에 두고 대응하고 싶었다.