mdoc-update - Online di Cloud

PROGRAM:

NAMA

pembaruan mdoc - mdoc(5) dukungan format dokumentasi

RINGKASAN

mdoc memperbarui [OPSI]* RAKITAN

DESKRIPSI

mdoc memperbarui bertanggung jawab untuk hal-hal berikut:

* Membuat rintisan dokumentasi berdasarkan PERAKITAN. Proses pembuatan rintisan akan
buat baru mdoc(5) file XML untuk setiap jenis di dalam PERAKITAN, dan berikan
rintisan dokumentasi untuk setiap anggota dari jenis tersebut.

* Perbarui rintisan dokumentasi berdasarkan PERAKITAN. Ada mdoc(5) dokumentasi dapat
diperbarui untuk mencerminkan perubahan dalam PERAKITAN, seperti jenis dan anggota yang ditambahkan,
sambil melestarikan dokumentasi yang ada.

Dalam beberapa keadaan terbatas, penggantian nama akan dilacak, meminimalkan
beban dokumentasi ketika misalnya parameter diubah namanya.

mdoc memperbarui tidak bergantung pada dokumentasi yang ditemukan dalam kode sumber, meskipun dapat mengimpor
Komentar Dokumentasi XML melalui -i .

Lihat mdoc(1) dan mdoc(5) untuk informasi lebih lanjut.

PILIHAN

--menghapus
mengizinkan mdoc memperbarui untuk menghapus anggota dari file dokumentasi. Satu-satunya anggota
dihapus adalah anggota yang tidak lagi hadir dalam PERAKITAN dan tidak
hadir dalam versi perakitan lainnya.

Jika suatu tipe tidak ada lagi, file dokumentasinya adalah tidak dihapus, tapi
sebagai gantinya berganti nama untuk memiliki sebuah .menghapus perpanjangan.

Deteksi versi dilakukan dengan //Versi Perakitan elemen; jika tidak ada
//Versi Perakitan elemen untuk yang diberikan or , lalu akan
berganti nama dan/atau akan dihapus.

--pengecualian[=SUMBER]
EKSPERIMENTAL. Ini tidak 100% dapat diandalkan, tetapi dimaksudkan sebagai bantuan untuk
penulis dokumentasi.

Periksa badan anggota untuk menentukan pengecualian apa yang dapat dihasilkan dari
anggota.

SUMBER adalah daftar opsional yang dipisahkan koma dari sumber berikut yang seharusnya
mencari pengecualian:

ditambahkan Hanya menghasilkan elemen untuk anggota
ditambahkan selama eksekusi program saat ini.
Ini mencegah pembaruan mdoc dari pembuatan ulang
elemen untuk semua anggota (dan dengan demikian
mencegah penyisipan ulang untuk anggota yang memiliki
elemen dihapus).
semua Temukan pengecualian yang dibuat di anggota itu sendiri,
referensi untuk anggota di majelis yang sama,
dan referensi ke anggota di dependen
majelis.
asm Temukan pengecualian yang dibuat di anggota itu sendiri dan
referensi ke anggota dalam majelis yang sama
sebagai anggota.
depasm Temukan pengecualian yang dibuat di anggota itu sendiri dan
referensi ke anggota dalam dependen
majelis.

If SUMBER tidak disediakan (default), maka hanya pengecualian yang dibuat di dalam
anggota itu sendiri akan didokumentasikan.

BATASAN: Pencarian pengecualian saat ini diimplementasikan dengan mencari
jenis pengecualian yang secara eksplisit dibuat berdasarkan jenis waktu kompilasi yang diketahui.
Ini memiliki batasan sebagai berikut:

* Ini tidak akan menemukan pengecualian yang tersirat ke IL, seperti
NullReferenceException dan IndexOutOfRangeException.

* Ini akan menemukan pengecualian yang tidak dilempar, misalnya

kekosongan publik CreateAnException ()
{
Pengecualian e = Pengecualian baru ();
}

* Ini tidak akan "mengikuti" panggilan delegasi dan antarmuka:

public void UseDelegates ()
{
fungsi a = x => {melempar Pengecualian baru ();};
sebuah (4);
}

Fungsi Menggunakan Delegasi() tidak akan ada pengecualian yang didokumentasikan.

* Ini akan menemukan pengecualian yang "tidak dapat terjadi", seperti
ArgumentNullExceptions untuk argumen yang "diketahui" bukan nol:

kekosongan publik A ()
{
B("parameter ini bukan null");
}

kekosongan publik B (string s)
{
jika (s == nol)
melempar ArgumentNullException baru ("s");
}

Untuk hal di atas, jika --pengecualian=asm disediakan maka SEBUAH() akan didokumentasikan
sebagai melempar ArgumentNullException, yang tidak bisa terjadi.

-f=BENDERA
Tentukan bendera untuk mengubah perilaku. Bendera yang valid meliputi:

versi tanpa perakitan
Lihat -fno-perakitan-versi dokumentasi, di bawah ini.

-fno-perakitan-versi
Jangan menghasilkan /Tipe/Info Perakitan/Versi Perakitan dan
/Jenis/Anggota/Anggota/Info Majelis elemen.

Ini berguna untuk mencegah "churn" selama pembaruan. Biasanya, jika tipe atau anggota
belum berubah tapi versi assembly sudah berubah, lalu semua tipe dan member
akan diperbarui untuk menyertakan yang baru //Versi Perakitan elemen, sehingga meningkatkan
jumlah perubahan yang perlu ditinjau sebelum melakukan (dengan asumsi semua perubahan adalah
benar-benar ditinjau sebelum komit).

PERINGATAN: Ini akan berinteraksi buruk dengan --menghapus pilihan, sebagai --menghapus menggunakan
//Versi Perakitan elemen untuk melacak perubahan versi. Jadi, jika Anda memiliki anggota
yang hadir dalam versi perakitan awal dan dihapus dalam versi berikutnya
versi perakitan, seperti: Sistem.Teks.UTF8Encoding.GetBytes(string) (yang mana
ada di .NET 1.0 tetapi tidak di .NET 2.0), maka anggota akan dihapus ketika
--menghapus -fno-perakitan-versi opsi ditentukan, anggota hadir dalam
versi perakitan sebelumnya, dan versi perakitan saat ini tidak
berisi anggota.

Oleh karena itu, opsi ini harus hanya ditentukan jika tipe dan anggotanya mau tak pernah
akan dihapus dari perakitan.

-i, --impor=FILE
Dokumentasi impor ditemukan di dalam FILE.

FILE mungkin berisi csc /dokter XML atau ECMA-335 XML.

-L, --lib=DIREKTORI
Add DIREKTORI ke jalur pencarian perakitan, sehingga dependensi dari PERAKITAN bisa
ditemukan tanpa mendokumentasikan rakitan tersebut.

-o, --keluar=DIREKTORI
Tempatkan rintisan yang dihasilkan ke dalam DIREKTORI.

Saat memperbarui dokumentasi, DIREKTORI juga merupakan direktori sumber.

-r=MAJELIS
MAJELIS adalah ketergantungan untuk salah satu dari PERAKITAN yang seharusnya tidak didokumentasikan tetapi
diperlukan untuk memproses salah satu dari PERAKITAN. Tambahkan direktori yang berisi MAJELIS untuk
jalur pencarian perakitan.

Opsi ini setara dengan menentukan -L `nama dirname PERAKITAN`.

--sejak=VERSION
Ketika memperbarui dokumentasi untuk perakitan, jika ditemukan tipe atau anggota
yang tidak ada di versi Majelis sebelumnya <sejak
versi="VERSION"/> elemen yang akan dimasukkan.

--Tipe=JENIS
Hanya perbarui dokumentasi untuk jenisnya JENIS.

-H, -?, --membantu
Tampilkan pesan bantuan dan keluar.

Gunakan mdoc-update online menggunakan layanan onworks.net