🌅 Miracle Monday Morning DevPost #1

 

혹시 여러분도 아래 코드 예시처럼 수정 사항 내용을 주석으로 쓰고 계신가요?

해당 방식은 이미 Anti-Pattern며 Apex 또는 DevOps 중 하나라도 모르면 자주 하는 실수입니다.

 

사항이 더 심해지는 경우는 일반적으로 몇 년 동안 많은 변경 사항을 겪은 클래스를 변경해야 할 때마다 주석 내용이 길어지기 시작합니다.

그리고, 한줄 변경 사항 내역도 코드 읽고 이해하는데에 도움을 못 주는 경우도 많죠.

시간이 지남에 따라 코드베이스는 이러한 주석으로 가득 차게 되고, 결과적으로 코드보다 더 많은 주석이 생깁니다.

 

이를 해결하기 위한 다른 더 나은 방법들이 있습니다:

1. 객체 지향 설계의 SOLID 중 개방-폐쇄 원칙 (Open/closed principle)에 준수합니다. 즉, 소프트웨어 요소는 확장에는 열려 있으나 변경에는 닫혀 있어야 하기 때문에 새로운 기능을 가능하도록 새로운 메소드로 추출하고 메소드에 Comment Tag를 잘 작성합니다.
2. 새로운 메소드가 많은 컨텍스트를 필요로 한다면, 해당 컨텍스트를 포함하는 내부 클래스나 새로 클래스로 Refactoring 하시면 됩니다.
3. 제일 중요한 부분인데!... Git과 버전 관리를 사용하십시오. Git을 사용하면 특정 코드 라인을 가리키고 그것에 대한 변경 내용과 누가 변경했는지를 확인할 수 있습니다.

 

혹시 여러분 선호하시는 또는 추가 하고 싶으신 팁들이 있다면 댓글로 남겨주세요.

---

Post by Obidjon

https://trailhead.salesforce.com/trailblazer-community/feed/0D54V00007XINZ4SAP