2012-01-08 3 views
5

어제 나는 attr_accessor의 작동 방식에 대해 answered a question입니다. 놀랍게도이 메서드의 설명서에 연결하고 싶었습니다. didn't show upruby-doc.org에 연결했습니다. Module.html에 문서화하면 안됩니까? ri Module#attr_accessorAPIDock은 정확한 문서를 표시하고 Google search은 첫 번째 조회수 중이 페이지를 산출하기 때문에 한 번 그곳에 있었던 것으로 확신합니다.`attr_accessor`와`Module`의 다른 메소드에 대한 공식 문서는 어디에 있습니까?

이제 내가 궁금한 점은 : 왜 그들은이 매우 일반적인 방법의 문서 (그리고 Module#define_method과 같은 다른 중요한 메서드)도 제거했는지 궁금합니다. 그리고 그것들에 대한 공식 문서는 어디에 있습니까?

+0

그래, 나도 그걸 찾았다. 다음은 무언가를 배우고 싶을 때 설명서보다 더 좋은 사이트입니다 : http://www.rubyist.net/~slagell/ruby/accessors.html. 나는 ruby-doc.org에 대한 문서가 없기 때문에 확신한다. http://ruby-doc.org/search.html?cx=011815814100681837392%3Awnccv6st5qk&q=attr_accessor&sa=Search&cof=FORID%3A9 – itdoesntwork

답변

5

그 (것)들에게이 방법의 분실 된 문서에 관하여. 다음과 같은 대답을 받았습니다.

이들은 개인적인 방법이며, 기본적으로 rdoc 출력에 나타나지 않습니다.

이, 불행한 상황이기 때문에 (그 사용을 피해야한다 그들은 일반적으로 구현 세부 사항이 아닌 공개 API의 일부이기 때문에) 대부분의 개인 방법 attr_ *와 같은 정말 일반적인 사용 을 의도와는 달리.

올바른 해결책이 무엇인지 잘 모릅니다. 두 번째 메일에서 제임스

:

나는 그렉 브라운 (Greg Brown), 에릭는 Hodel 및 1.9의 rdocs을 개선하기 위해 노력하고 있습니다 약간 다른 사람과이 문제를 논의했다.

일반적인 합의는 모든 개인 방법을 보여주는 것은이 (아마도 실수) 한 마이너 릴리스 옆에 로 변경되기 쉽다 사용 방법 사람들을 격려 것이라고에서 좋은 생각이 될 것입니다. 그러나 그들은 공평한 방식으로 사용되는 기술적으로 사적이고, 문서는 이 기본적으로 나타날 필요가 있지만 attr_ *와 같은 사적인 방법이 있다는 것을 알고 있습니다.

소스 코드에서 C 소스 코드에서 이들에 대한 코드에 일부 rdoc 지정 문을 설정해 보았지만 아무 효과가 없습니다.필요한 것은 행동 양식에 개인용이지만 문서 용으로 공개한다는 것을 나타내는 몇 가지 추가 방법입니다.

1.9 의사 개선 팀 에 대해 알아보기 위해 다음 단계를 따라야합니다.

감사합니다,

제임스 브릿

또한 자세한 내용은이 문제에 대한 제임스 다른 문에 대한 this thread를 참조하십시오. 이 스레드에서 그는 또한 Ruby 코드의 정확한 문제를 해결하기 위해 일반적으로 RDoc에서 사용할 수있는 :doc: 지시어가 C 레벨 문서에서는 작동하지 않는다고 말합니다.

이 대답은 합리적인 것 같습니다. 어쩌면 그들은 미래에 그것을 바꿀 것입니다.

+0

후속 조치를 보내 주셔서 감사합니다. –

+1

안녕하세요, 저입니다! 스택 오버플로 질문 때문에 스레드가 시작되었습니다. –

+0

@Andrew : 안녕하세요. 우연의 일치인가요? 그것은 작은 세계, 그 루비 :) –

1

apidoc version

나는 거기에서 모든 것을 얻을.

오, 질문을 편집했습니다.

예, 이어야합니다.이 있어야하지만 많은 C 메소드가 더 이상 존재하지 않는 것처럼 보입니다.

+0

나는 그것에 대해 안다. APIDock은 공식 문서가 아닙니다. 맞습니까? rubydoc.org에없는 이유를 알고 있습니까? –

+0

@NiklasBaumstark 같은 소스에서 생성되었습니다. 개인적으로는 [sdoc] (https://github.com/voloko/sdoc)을 사용하여 로컬에서 문서를 실행하므로 걱정할 필요가 없습니다. –

+0

답변을 드린 후 죄송합니다. 처음부터 본문에 있던 질문을 반영합니다. –