중요 : 우리가하지 더 문제 와 어떠한 소스 코드 문서를 . 이것은 정기적 인 코드 감사에 속하며 최신 상태로 유지됩니다. 우리의 문제는 개발자 문서 (또는 원하는 경우 “외부”), 프로그래머에서 프로그래머가 작성하는 경향이있는 블로그와 같은 작은 팁과 관련이 있습니다.

우리는 위키와 같은 시스템을 사용하여 프로그래머 문서 를 작성 합니다. 프로그래머가 특정 코드가 어떻게 작동하는지 좀 더 자세하게 설명 하기 위해 프로그래머가 작성한 기사 입니다. 이러한 위키 페이지에는 일반적으로 다음이 포함됩니다.

• API의 일부에 대한 디자인 결정에 대한 동기 부여 (예 : 이 특정 타사 라이브러리는 이런 방식으로 작업을 수행하기를 원하기 때문에이 추한 일을했습니다 .이 라이브러리는 …이기 때문에 …)
• 특정 공통 작업을 처리하는 방법에 대한 설명 (예 : 적절한 응용 프로그램 스타일을 참조하고 레지스트리 구성 요소에 등록하고 다른 구성 요소에 의해 자동으로 “스캔”되도록 일부 인터페이스를 구현해야하는 간단한 팝업 표시)
• 좋은 관행
• 환경 구성, 필수 도구 및 설정

일반적으로 크기 및 블로그 게시물 / 문서와 같은 특성으로 인해 정기적 인 코드 문서화에 맞지 않는 코드 작성과 관련된 것들입니다.

문제

몇 달 전이 시스템을 도입하는 것이 좋은 생각 인 것처럼 요즘에는 시스템이 해결하는 것보다 더 많은 문제를 일으키는 것 같습니다. 예를 들면 다음과 같습니다.

• 사람들 은 기사를 쓰지만 … 일단 코드가 변경되면 위키 업데이트는 거의 따르지 않습니다.
• 많은 스크래치 기사, 서둘러 누군가에 의해 쓴처럼 왼쪽
• 기사 요청은 일반적으로 프로젝트 리더가 제공하지만 정확성 / 조성에 대한 검증은 거의 이루어지지 않아 때로는 품질이 떨어집니다.

일반적인 저하. 코드가 변경되었으며 위키는 동일하게 유지됩니다. 다음에 누군가 정보를 찾을 때, 일반적으로 그가 발견하는 것은 오래되고 품질이 낮은 것들입니다. 그리고 그가 찾은 것이 정확한지 또는 더 나쁜지에 대해 궁금해하고 있습니다. 그리고 도움이 되었어야했던 것은 정반대입니다.

현재 사람들이 문제를 알고 있고 프로젝트 리드가 포함 된 것으로 보이지만 아무도 그 문제를 다루는 데 신경 쓰지 않는 것 같습니다 (또는 더 흥미로운 일을하고 있음).

나의 초기 생각은 모든 것을 망각에 던져 넣는 것이었다 (내가 구식 “팁”에 몇 번 연속 물린 후에), 나는 그것이 너무 극단적이라고 생각합니다. 일부 정보는 가치가 주목할 좋은 가끔 읽어하지만 문제는 여전히 동일합니다 : 당신은 그것의 처리 방법 “최신” ? 어떻게 든 소스 코드에 링크되어 있습니까 (따라서 업데이트 된 버전의 파일을 체크인하면 기사 작성자가 코드 / 기사를 수정해야 할 수도 있음을 알립니다)? 지정된 사람이 매일 기본 사항에 대해 “감시”했습니까? 정기적으로 청소합니까?

답변

# Routine by mdd on 7/25/2012
# processes cars for sale
a=0
col = Car.all
Collection.loop |a|
 if a.stat = 'fs' then
   a+= a.value
   call easo
  endif
end

accumulating_potential_sale_revenue = 0
cars_to_check = Car.all
cars_to_check.loop |one_car|
  if one_car.sell_status == 'for_sale'
    accumulating_potential_sale_revenue+= one_car.sale_price
    call email_about_special_offer(car)
  endif
end