2010-05-07 4 views
7

어떻게Mathematica에 대한 Doxygen은 무엇입니까?

  • 파라미터 사양처럼 티카 패키지 파일에
  • 의 doctest/사용 예를 추가 정보를 넣을까요?

지금까지 필자는 설명서 문자열을 쓰는 방법에 대해 :: usage 문자열과 some information을 발견했습니다. 패키지 파일을 조사하여이 문서 노트북을 생성 할 수있는 옵션을 찾고 있습니다.

답변

3

mathematica에 내장 된 doxygen과 같은 메커니즘이 있는지 모르겠습니다. 당신이 당신의 패키지에 통합 문서 노트북을 포함 할 경우

  1. 는 도움말 기능을 쓰기 문서 노트북
  2. 삽입 패키지의 문자열로 노트북을 쓰기 나는 다음과 같이 진행 것이라고, 때 라는, 파일을 상자 노트북에서 작성하고 그것을 열어 프런트 엔드 조작을 사용
당신은 문서 N을 저장하는 대신에 문자열의 Notebook[]를 사용하여 외부 노트북의 작성을 생략 할 수있을 것

패키지 파일 안의 otebook.

Mathematica의 도움말 시스템과 통합하는 것은 좀 더 어렵습니다. 물론 패키지가로드 될 때 해당 패키지를 작성하고 적절한 위치로 옮길 수 있습니다.