phoenix-framework
परियोजना प्रलेखन उत्पन्न करें

Docker Elixir Language Erlang Language HTML JavaScript MySQL Node.js postgresql React Ruby on Rails

दलील

सहायक मॉड्यूल और कार्यों का सही आह्वान डराने वाला हो सकता है क्योंकि

ये गतिशील रूप से उत्पन्न होते हैं (जैसे, एक नई परियोजना बनाते समय या एक नया resource जोड़ना)
वे स्पष्ट रूप से प्रलेखित नहीं हैं (उदाहरण के लिए, MyApp.ErrorHelpers.error_tag )
प्रलेखन सभी उदाहरणों को शामिल नहीं करता है (जैसे, MyApp.Router.Helpers.*_path Phoenix.Router में MyApp.Router.Helpers.*_path । Phoenix.Router )।

हालाँकि बनाए गए सहायक आपके पूरे प्रोजेक्ट में बिखरे हुए हैं, लेकिन उनका स्थान एक ठोस तर्क का अनुसरण करता है। आप उन्हें बहुत जल्दी और सौभाग्य से इस्तेमाल कर सकते हैं, जब आप फीनिक्स के साथ एक परियोजना उत्पन्न करते हैं, तो कोड को @doc के @doc और @moduledoc मॉड्यूल विशेषताओं के माध्यम से प्रलेखन के साथ भेज दिया जाता है।

ये डॉक्स केवल सहायकों तक ही सीमित नहीं हैं, बल्कि आप भी कर सकते हैं

अपने प्रोजेक्ट को सबमॉडल्स / फ़ंक्शंस / मैक्रोज़ द्वारा तोड़ कर देखें
अपने स्वयं के प्रलेखन जोड़ें
किसी भी कार्य करता है कि आपके परियोजना के नाम स्थान के तहत उत्पन्न किया गया देखो (जैसे, MyApp.Repo कॉलबैक फ़ंक्शन कार्यान्वयन से शामिल Ecto.Repo )

डॉक्स उत्पन्न करना

अपने स्रोत कोड से प्रलेखन उत्पन्न करने के लिए जोड़ने के ex_doc अपने में निर्भरता के रूप में mix.exs फ़ाइल:

# config/mix.exs

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

आप Elixir @doc और @moduledoc विशेषताओं के भीतर @doc का उपयोग कर सकते हैं।

फिर, नए मॉड्यूल्स लाने और संकलित करने के लिए mix deps.get और mix docs साथ प्रोजेक्ट डॉक्यूमेंटेशन जनरेट करें। एक उदाहरण आउटपुट आधिकारिक अमृत डॉक्स है ।

उनकी सेवा करने के लिए तुरंत mix docs --output priv/static/doc का उपयोग करें और my_app_url_or_ip/doc/index.html नेविगेट करें।

अतिरिक्त पढ़ने:

इस गाइड के थोक को अमृत व्यंजनों से संदर्भित किया गया है।

Modified text is an extract of the original Stack Overflow Documentation

के तहत लाइसेंस प्राप्त है CC BY-SA 3.0

से संबद्ध नहीं है Stack Overflow