레일 앱 문서 규칙?

Question

기술적 인 질문보다는 예술 상태라는 것을 알았지 만 모델 관계, 유효성 검사, 모델 및 컨트롤러에 대한 방법을 문서화하기위한 좋은 템플릿을 찾고 있습니다.

이를 수행하기위한 규칙/모범 사례/예가 있습니까? 모든 도움을

덕분에

Answer 1

당신이 RDoc을 사용할 수있는 코드를 자동 문서화합니다. 코드 주석을 받아 프로젝트 문서를 작성합니다. http://rdoc.rubyforge.org/

http://en.wikibooks.org/wiki/Ruby_Programming/RubyDoc

그것은 꽤 깔끔한

• .

  유효성 검사와 관계를 문서화하는 데 많은 도움이되지는 않을지 모르겠다. Ruby 소스 코드는 이미 그 점에서 믿어지지 않는다.