yardoc - Dalam talian dalam Awan

JADUAL:

NAMA

yardoc - Alat Ruby untuk menjana dokumentasi untuk bahasa pengaturcaraan Ruby

SINOPSIS

yarddoc [pilihan] [source_files [- extra_files]] limbungan doc [pilihan] [source_files [-
extra_files]]

DESCRIPTION

limbungan(1) ialah alat penjanaan dokumentasi yang boleh diperluaskan untuk bahasa pengaturcaraan Ruby.
Ia membolehkan pengguna menjana dokumentasi yang konsisten dan boleh digunakan yang boleh dieksport ke a
bilangan format dengan sangat mudah, dan juga menyokong lanjutan untuk binaan Ruby tersuai sedemikian
sebagai takrifan peringkat kelas tersuai.

yardoc, sinonim untuk limbungan doc menjana dokumentasi daripada senarai source_files. Jika
senarai ini ditinggalkan, "{lib,app}/**/*.rb ext/**/*.c" digunakan.

Satu set asas pilihan boleh ditentukan dengan menambah a .yardopts fail ke laluan asas anda
mengandungi semua pilihan tambahan yang dipisahkan oleh ruang putih.

PILIHAN

Umum Pilihan
-b, --db FAIL
Gunakan db .yardoc yang ditentukan untuk memuatkan atau menyimpan ke (lalai kepada .yardoc)

--[NO-]single-db
Sama ada objek kod harus disimpan ke fail pangkalan data tunggal (lanjutan)

-n, --tiada-keluaran
Hanya jana pangkalan data .yardoc, tiada dokumentasi.

-c, --gunakan-cache [FAIL]
Gunakan .yardoc db yang dicache untuk menjana dokumentasi (lalai kepada tiada cache)

--tiada-cache
Kosongkan .yardoc db sebelum menghuraikan sumber.

--[NO-]yardopts [FAIL]
Jika hujah harus dibaca daripada FILE (lalai kepada ya, FILE lalai kepada .yardopts)

--[NO-]dokumen
Jika argumen harus dibaca dari fail .document (lalai kepada ya)

--tidak-simpan
Jangan simpan data yang dihuraikan ke yardoc db

--kecualikan REGEXP
Mengabaikan fail jika ia sepadan dengan padanan laluan (regexp)

Output pilihan
--satu-fail
Menghasilkan output sebagai satu fail

--senarai
Senaraikan objek untuk standard out (menyiratkan -n)

--tiada-awam
Jangan tunjukkan kaedah awam. (lalai menunjukkan umum)

--dilindungi
Tunjukkan kaedah yang dilindungi. (penyorok lalai dilindungi)

--swasta
Tunjukkan kaedah peribadi. (lalai menyembunyikan peribadi)

--tidak-peribadi
Sembunyikan objek dengan tag @private

--[no-]api API
Menjana dokumentasi untuk API tertentu (objek yang mentakrifkan teg @api yang betul).
If --no-api diberikan, memaparkan objek tanpa tag @api.

--embed-mixins
Benamkan kaedah mixin ke dalam dokumentasi kelas

--embed-mixin [MODUL]
Benamkan kaedah mixin daripada modul tertentu ke dalam dokumentasi kelas

--tiada-highlight
Jangan serlahkan blok kod dalam output.

--default-return JENIS
Ditunjukkan jika kaedah tidak mempunyai jenis pulangan. (lalai kepada 'Objek')

--sembunyikan-kosong-kembali
Menyembunyikan jenis pulangan yang dinyatakan sebagai 'kosong'. (lalai ditunjukkan)

--pertanyaan PERTANYAAN
Hanya tunjukkan objek yang sepadan dengan pertanyaan tertentu

--tajuk TITLE
Tambahkan tajuk khusus pada dokumen HTML

-r, --baca saya, --utama FAIL
Fail readme digunakan sebagai halaman tajuk dokumentasi.

--fail FAIL1,FAIL2, ...
Sebarang fail statik dipisahkan koma tambahan untuk disertakan (cth. Soalan Lazim)

--aset DARIPADA[:KEPADA]
Fail atau direktori untuk disalin ke direktori output selepas dijana

-o, --output-dir PATH
Direktori output. (lalai kepada ./doc)

-m, --penanda MARKUP
Gaya penanda yang digunakan dalam dokumentasi, seperti tekstil, penurunan nilai atau rdoc (lalai kepada rdoc).

-M MARKUP_PROVIDER
Mengatasi perpustakaan yang digunakan untuk memproses penanda

--pembekal-penanda
pemformatan (nyatakan nama permata)

--charset HIDUP
Set aksara untuk digunakan semasa menghuraikan fail (lalai ialah tempat sistem)

-t, --template TEMPLAT
Templat untuk digunakan. (lalai kepada "lalai")

-p, --jalan-template PATH
Laluan templat untuk mencari templat masuk. (digunakan dengan -t).

-f, --format FORMAT
Format output untuk templat (lalai kepada html).

--tiada-statistik
Jangan cetak statistik

--tempatan TEMPAT
Tempat untuk dokumentasi yang dijana (lalai kepada en).

--po-dir DIR
Direktori yang mempunyai fail .po (lalai kepada #{YARD::Registry.po_dir}).

Tag pilihan yang berikut:
(TAG:TITLE kelihatan seperti: 'beban:Terlampau kaedah')

--tag TAG:TITLE
Mendaftarkan metadata bentuk bebas baharu @tag

--type-tag TAG:TITLE
Teg dengan medan jenis pilihan

--type-name-tag TAG:TITLE
Teg dengan jenis pilihan dan medan nama

--tag nama TAG:TITLE
Tandai dengan medan nama

--tag tajuk TAG:TITLE
Teg dengan baris pertama sebagai medan tajuk

--tag sembunyi TAG
Menyembunyikan teg yang ditakrifkan sebelum ini daripada templat

--tag transitif TAG
Menandai teg sebagai transitif

--bukan-transitif-tag TAG
Menandai teg sebagai bukan transitif

lain-lain pilihan yang berikut:
-e, --muat FAIL
Skrip Ruby untuk dimuatkan sebelum menjalankan arahan.

--pasangkan PASANGKAN
Muatkan pemalam YARD (permata dengan awalan `yard-')

--warisan
Gunakan penghurai dan pengendali Ruby gaya lama. Sentiasa hidup dalam 1.8.x.

--selamat
Dayakan mod selamat untuk contoh ini

-q, --senyap
Jangan tunjukkan amaran.

--verbose
Tunjukkan maklumat lanjut.

--nyahpepijat
Tunjukkan maklumat penyahpepijatan.

--jejak belakang
Tunjukkan jejak tindanan

-v, --versi
Tunjukkan versi.

-h, - membantu
Tunjukkan bantuan ini.

CONTOH

yardoc -o "dokumentasi/" - "Soalan Lazim" "LESEN"

Contoh di atas mengeluarkan dokumentasi untuk fail dalam "lib/**/*.rb" kepada "documentation/"
termasuk fail tambahan "Soalan Lazim" dan "LESEN".

Gunakan yardoc dalam talian menggunakan perkhidmatan onworks.net