phoenix-framework
프로젝트 문서 생성

이론적 해석

도우미 모듈과 함수의 올바른 호출은 협박 할 수 있습니다.

• 동적으로 생성됩니다 (예 : 새 프로젝트를 만들거나 새 resource 추가 할 때)
• 명시 적으로 문서화되지 않았습니다 (예 : MyApp.ErrorHelpers.error_tag ).
• 문서는 모든 예제 적용되지 않습니다 (예를 들어, MyApp.Router.Helpers.*_path 에서 Phoenix.Router ).

생성 된 도우미가 프로젝트 전체에 흩어져 있지만 위치는 견고한 논리를 따릅니다. 다행스럽게도 Phoenix로 프로젝트를 생성 할 때 Elixir의 @doc 및 @moduledoc 모듈 속성을 통해 문서가 제공됩니다.

이 문서는 도우미에만 국한되지 않고

• 하위 모듈 / 함수 / 매크로로 분류 된 프로젝트보기
• 나만의 문서 추가
• 프로젝트의 네임 스페이스 아래에서 생성 된 모든 함수를 찾습니다 (예 : MyApp.Repo 에는 MyApp.Repo 콜백 함수 구현이 Ecto.Repo )

문서 생성

소스 코드에서 문서를 생성하려면 ex_doc 을 mix.exs 파일에 종속성으로 추가하십시오.

# config/mix.exs

def deps do
  [{:ex_doc, "~> 0.11", only: :dev}]
end

Elixir @doc 및 @moduledoc 속성 내에서 Markdown을 사용할 수 있습니다.

그런 다음 mix deps.get 을 실행하여 새 모듈을 가져 와서 컴파일하고 mix docs 프로젝트 문서를 생성합니다. 출력 예제는 공식 Elixir Docs 입니다.

이들을 즉시 제공하려면 mix docs --output priv/static/doc 를 사용하고 my_app_url_or_ip/doc/index.html .

추가 독서 과제 :

• ex_doc
• 버전 요구 연산자 ( Elixir.Version )

이 가이드의 대부분은 Elixir Recipes 에서 참조됩니다.