Hujjat - Docstring

Yilda dasturlash, a dokstring a string literal ko'rsatilgan manba kodi a kabi ishlatilgan sharh, kodning ma'lum bir segmentini hujjatlashtirish uchun. Oddiy manba kodi sharhlaridan yoki hattoki maxsus formatlangan sharhlardan farqli o'laroq Javadoc hujjatlar, docstrings tahlil qilinayotganda manba daraxtidan olib tashlanmaydi va dasturning ishlash muddati davomida saqlanib qoladi. Bu dasturchiga ushbu sharhlarni ishlash vaqtida tekshirishga imkon beradi, masalan, interaktiv yordam tizimi sifatida yoki metadata.

Birinchi marta asl nusxada kiritilgan ko'rinadi TECO amalga oshirish Emak.[1]

Hujjatlarni qo'llab-quvvatlovchi tillarga quyidagilar kiradi Python, Lisp, Elixir, Klojure,[2] Gherkin,[3] Yuliya[4] va Xaskell.[5]

Amalga oshirish misollari

Elixir

Hujjatlar til darajasida, dokstring shaklida qo'llab-quvvatlanadi. Markdown - bu Elixir-ning amaldagi formatlash tili, bu docstrings-da foydalanish uchun tanlangan:

def modul MyModule qil  @moduledoc """  Mening modulim uchun hujjatlar. ** formatlash bilan **.  """  @doc "Salom"  def dunyo qil    "Dunyo"  oxirioxiri

Lisp

Lispda dokstringlar hujjatlar satrlari sifatida tanilgan. The Umumiy Lisp standart shuni ko'rsatadiki, ma'lum bir dastur har qanday sababga ko'ra istalgan vaqtda dokstringlarni tashlashni tanlashi mumkin. Ular saqlanganda Hujjatlar funktsiyasidan foydalangan holda dokstringlarni ko'rish va o'zgartirish mumkin.[6] Masalan; misol uchun:

 (bekor qilish foo () "salom" nol) (hujjatlar #'foo funktsiyasi) => "salom"

Python

Kod ob'ektini ta'rifining boshida hujjatlashtirishning keng tarqalgan amaliyoti Python tilida docstring sintaksisining qo'shilishi bilan qo'lga kiritilgan.

Python kod ob'ekti uchun docstring (modul, sinf yoki funktsiya) ushbu kod ob'ektining birinchi bayonoti bo'lib, ta'rifdan so'ng darhol ('def' yoki 'class' iborasi). Bayonot boshqa turdagi iboralar emas, balki yalang'och mag'lubiyatga ega bo'lishi kerak. Kod ob'ekti uchun docstring ushbu kod ob'ektida mavjud __doc__ xususiyati va orqali Yordam bering funktsiya.

Quyidagi Python fayli Python manba fayli ichidagi docstrings deklaratsiyasini ko'rsatadi:

"" "Modul dokstringi" ""sinf MyClass:    "" "Sinf hujjatlari" ""    def my_method(o'zini o'zi):        "" "Usulning doktringi" ""def my_function():    "" "Funktsiya dokstringi" ""

Yuqoridagi kod sifatida saqlangan deb taxmin qilsak mymodule.py, quyida dokstringlarga qanday kirish mumkinligini ko'rsatadigan interaktiv mashg'ulot mavjud:

>>> Import mymodule>>> Yordam bering(mymodule)Modulning dokstringi>>> Yordam bering(mymodule.MyClass)Sinf doktringi>>> Yordam bering(mymodule.MyClass.my_method)Usulning doktringi>>> Yordam bering(mymodule.my_function)Funktsiyaning dokstringi>>>

Dstrstrlardan foydalanadigan vositalar

Shuningdek qarang

Adabiyotlar

  1. ^ "EMACS: kengaytiriladigan, moslashtiriladigan displey muharriri".
  2. ^ Clojure-dagi docstring bilan funktsiyani aniqlash
  3. ^ "Qadam argumentlari - hujjat satrlari". Arxivlandi asl nusxasi 2016-01-31 da. Olingan 2016-06-22.
  4. ^ http://docs.julialang.org/en/stable/manual/documentation/
  5. ^ https://hackage.haskell.org/package/docstrings
  6. ^ CLHS: Standart umumiy funktsiyalar Hujjatlari ...

Tashqi havolalar