سلسلة التوثيق

يتم دعم التوثيق على مستوى اللغة، في شكل سلاسل توثيق. تُعتبر لغة Markdown لغة الترميز المُفضلة لدى Elixir للاستخدام في سلاسل التوثيق.

def module MyModule do @moduledoc """ توثيق الوحدة الخاصة بي. مع **التنسيق**. """@doc "Hello" def world do "World" end end

في لغة ليسب، يُعرف نص التوثيق باسم سلسلة التوثيق. ينص معيار كومون ليسب على أنه يجوز لأي تطبيق حذف نصوص التوثيق. عند الاحتفاظ بها، يمكن عرض نصوص التوثيق وتعديلها باستخدام الدالة DOCUMENTATION. ^{[ 5 ]} على سبيل المثال:

( defun foo () "مرحبًا" nil ) ( الوثائق #' foo 'function ) => "مرحبًا"

في لغة بايثون، سلسلة التوثيق هي سلسلة نصية حرفية تلي تعريف وحدة أو فئة أو دالة. يجب أن تكون سلسلة نصية حرفية فقط، وليست أي نوع آخر من التعبيرات. يمكن الوصول إلى سلسلة التوثيق عبر __doc__سمة عنصر الكود المرتبط بها helpوالدالة.

يُعرّف كود بايثون التالي سلاسل التوثيق لكل عنصر من عناصر البرنامج:

"""سلسلة توثيق الوحدة"""class MyClass : """سلسلة توثيق الفئة"""def my_method ( self ): """سلسلة توثيق الدالة"""

إذا تم حفظ الملف باسم mymodule.py ، فستكون الجلسة التالية تفاعلية توضح كيفية الوصول إلى سلاسل التوثيق:

>>> import mymodule >>> help ( mymodule ) توثيق الوحدة >>> help ( mymodule . MyClass ) توثيق الفئة >>> help ( mymodule . MyClass . my_method ) توثيق الدالة