C refactorings and code smells catalog - minsuk-jang/teamproject GitHub Wiki

Neovim은 큰 refactoring 노력입니다. 이 주제에 관한 문헌에서 아이디어를 얻는 것이 도움이 될 것입니다. 기여자는 악의적인 코드 냄새를 감지하고 오래된 / 문서화되지 않은 / 테스트되지 않은 코드를 다룰 때 필요한 주의사항을 적용하여 필요한 refactoring을 적용하는 것이 좋습니다.

여기에 있는 목록은 완전한 것이 아니므로 코드에서 발견 될 수있는 문제에 대한 완벽한 처방으로 간주 되어서는 안됩니다. 융통성있게 하십시오.

C Refactorings 목록

neovim의 코드베이스를 향상시키는 동안 우리를 안내 할 수 있는 C Refactorings 목록.

Garrido 2000 [** ** 2.1 C refactorings 목록 제안 ** ** (page 17)

프로그램 entity 추가하기

• 변수 추가
• 함수에 매개 변수 추가
• 기존 유형을 캡슐화하는 typedef 정의 추가
• 구조체에 필드 추가
• **변수에 포인터를 추가하십시오 : **선택된 변수의 유형과 동일한 유형의 포인터 변수의 선언을 추가하고 포인터에 선택한 변수의 주소를 할당하십시오.

프로그램 entity 삭제

• 사용하지 않는 변수 삭제
• 사용하지 않은 매개 변수 삭제
• 함수 삭제

프로그램 entity 변경

• 변수 이름 변경
• 상수 이름 변경
• 사용자 정의 유형 이름 변경
• 구조 필드 이름 변경
• 함수 변경
• 프로그램 entity의 유형 변경
• 계약 변수 범위
• 가변 범위 확장
• 값을 상수로 변경
• 표현식을 변수로 변경
• 변수를 포인터로 변환
• 포인터를 직접 변수 접근으로 변환
• 전역 변수를 매개 변수로 변환 : 지정된 전역 변수에 접근하는 모든 함수를 찾습니다. 각 함수에 대해 형식 정의 매개 변수를 함수 정의에 추가하고, 전역 변수를 함수 호출에서 실제 매개 변수로 추가 한 다음 매개 변수에 대한 함수 내의 전역 변수에 대한 접근을 바꾸십시오. 사용자는 매개 변수가 포인터 유형인지 선택할 수 있습니다.
• **함수 인수 재정렬 : ** 함수 정의 및 해당 함수에 대한 모든 호출에서 인수의 순서를 변경합니다.

복잡한 refactorings

• 새로운 구조에서 일련의 변수 그룹화 : (e.g., #775) legacy 시스템은 종종 프로그램을 재사용 할 수 없게 만드는 전역 변수를 과도하게 사용합니다. 사소한 경우와 같은 대부분의 변경 사항 가능한 경우 글로벌 업데이트가 필요합니다. 그러나 프로그래머는 전역 변수를 매개 변수로 전달해야 할 때 전역 변수를 사용합니다. 너무 많은 매개 변수를 함수에 전달하면 호출 시간이 길어질 수 있습니다.

  이 문제에 대한 해결책은 격리 된 변수를 그룹화하는 데이터 구조를 정의하고 구조에 대한 단일 참조를 매개 변수로 전달하는 것입니다. 이 refactoring은 기존 변수를 그룹화하여 구조를 정의합니다. 참조에 의한 매개 변수에 대한 전역 접근 변환의 두 번째 부분은 리팩토링 "전역 변수를 매개 변수로 변환"에서 처리됩니다.

• 추출 기능: 복잡한 표현이나 문장 목록을 함수 호출로 바꿉니다. [Fowler 99]에서 지적했듯이 이것은 매우 일반적인 변형입니다. 함수가 너무 길거나 복잡해지면 작은 조각으로 나누고 각 조각을 함수로 바꾸고 더 짧은 함수를 함수 호출로 대체하는 것이 좋습니다. 추출 된 코드가 스캔되고 원본 함수의 지역 변수에 대한 각 참조에 대해 매개 변수가 추출 된 함수에 추가됩니다. I (@philix)는 더 이상 좋은 refactoring 패턴으로 함수 추출을 권장하지 않습니다. 나는 (1) 새로운 함수가 순수(https://en.wikipedia.org/wiki/Pure_function) 이거나 (2) 이미 재사용의 구체적인 경우가있을 때만 함수를 추출해야한다고 생각합니다. John Carmack이 John Carmack in Inlined Code에서 이 주제에 대해 설명합니다.

• 인라인 함수

• 조건식 통합: 스위치에서 인접 사례를 결합하십시오.

• For into while

• While into for

• While into do while: while 문에 대한 조건을 역전시키는 문장을 변환합니다.

Code Smells

코드 목록에는 해결할 수 있는 문제를 나타내고 네빌 헌납자의 마음을 사로 잡을 수 있는 Jeff Atwood의 냄새가 납니다. 이 목록은 객체 지향 프로그래밍을 위해 만들어졌지만 대부분 C에서 어떻게 적용되는지를 보기가 어렵지 않습니다.

Within Classes Code Smells (.c files)

• Comments
• Long Method (long functions)
• Long Parameter List
• Duplicated Code
• Conditional Complexity
• Combinatorial Explosion
• Large Class (large .c files)
• Type Embedded in Name
• Uncommunicative Name
• Inconsistent Names
• Dead Code
• Speculative Generality
• Oddball Solution
• Temporary Field (temporary global variable)

Code Smells Between Classes (between .c files)

• Alternative Classes with Different Interfaces
• Primitive Obsession #775
• Data Class
• Data Clumps
• Refused Bequest
• Inappropriate Intimacy
• Indecent Exposure
• Feature Envy
• Lazy Class
• Message Chains
• Middle Man
• Divergent Change
• Shotgun Surgery
• Parallel Inheritance Hierarchies
• Incomplete Library Class
• Solution Sprawl

C Refactoring 도구

Coccinelle

http://coccinelle.lip6.fr/

할 수 있는 일에 대한 예는 # 690을 참조하십시오.