저는 "스파게티 코드"프로젝트를 진행 중이며 버그를 수정하고 새로운 기능을 구현하는 동안 코드를 단위로 테스트 할 수 있도록 리팩토링도합니다.
코드는 종종 너무 밀접하게 결합되거나 복잡하여 작은 버그를 수정하면 많은 클래스가 다시 작성됩니다. 그래서 리팩토링을 중단하는 코드 어딘가에 선을 그리기로 결정했습니다. 이를 명확히하기 위해 상황에 대해 설명하는 코드에 다음과 같은 주석을 추가합니다.
class RefactoredClass {
private SingletonClass xyz;
// I know SingletonClass is a Singleton, so I would not need to pass it here.
// However, I would like to get rid of it in the future, so it is passed as a
// parameter here to make this change easier later.
public RefactoredClass(SingletonClass xyz) {
this.xyz = xyz;
}
}
또는 다른 케이크 조각 :
// This might be a good candidate to be refactored. The structure is like:
// Version String
// |
// +--> ...
// |
// +--> ...
// |
// ... and so on ...
//
Map map = new HashMap<String, Map<String, Map<String, List<String>>>>();
이것이 좋은 생각입니까? 그렇게 할 때 무엇을 명심해야합니까?
1
관련 / 중복 : TODO 주석이 의미가 있습니까?
—
gnat
이것은 의견 기반 주제입니다. 하지만 내 개인적인 의견은이 점이다 정확히 유용 주석의 유형, 나는 다른 사람의 코드에서 찾을 텐데 것을 : 그것은 당신에게 이미 코드에서 명확하지 않다 중요한 정보를 알려줍니다; 아니 무슨 방법 않지만, 왜 .
—
Kilian Foth
HashMap <문자열, 맵 <문자열, 맵 <문자열, 목록 <문자열 >>>> : o
—
margabit
왜 코드 조각이 냄새가 나는지 알려주는 의견 은 엄청나게 감사합니다. 코드베이스에 대해 이해하지 못했을 수도 있으므로 문제를보고 "What fuck?"을 생각할 것입니다. 그러나 그 이유를 설명하는 주석은 코드를 더 빨리 돌파하는 데 도움이됩니다. 그렇습니다. (물론 WTF가 아닌 코드를 고칠 수 없다고 가정!)
—
Phoshi