ນີ້ແມ່ນ monodocer ຄໍາສັ່ງທີ່ສາມາດດໍາເນີນການໄດ້ໃນ OnWorks ຜູ້ໃຫ້ບໍລິການໂຮດຕິ້ງຟຣີໂດຍໃຊ້ຫນຶ່ງໃນຫຼາຍໆບ່ອນເຮັດວຽກອອນໄລນ໌ຂອງພວກເຮົາເຊັ່ນ Ubuntu Online, Fedora Online, Windows online emulator ຫຼື MAC OS online emulator
ໂຄງການ:
NAME
monodocer - ສະຫນັບສະຫນູນຮູບແບບເອກະສານ ECMA
ສະຫຼຸບສັງລວມ
monodocer [ຕົວເລືອກ]*
OPTIONS
- ປະກອບ: ASSEMBLY
ASSEMBLY ເປັນ .NET ປະກອບເພື່ອສ້າງ stubs ເອກະສານສໍາລັບ.
ລະບຸເສັ້ນທາງໄຟລ໌ ຫຼືຊື່ຂອງຊຸດ GAC'd.
-ລຶບ
ອະນຸຍາດໃຫ້ monodocer ລຶບສະມາຊິກອອກຈາກໄຟລ໌ເອກະສານ. ສະມາຊິກເທົ່ານັ້ນ
ລົບແມ່ນສໍາລັບສະມາຊິກທີ່ບໍ່ມີຕໍ່ໄປອີກແລ້ວຢູ່ໃນສະພາແຫ່ງ.
ຖ້າປະເພດບໍ່ມີຕໍ່ໄປອີກແລ້ວ, ເອກະສານເອກະສານແມ່ນ ບໍ່ ຖືກລົບ, ແຕ່ແມ່ນ
ແທນທີ່ຈະເປັນ ປ່ຽນຊື່ to have a .ເອົາອອກ ການຂະຫຍາຍ.
-?, -ຊ່ວຍ
ສະແດງຂໍ້ມູນການໂຕ້ຖຽງຂອງໂປຣແກຣມ.
- ບໍ່ສົນໃຈ
ຢ່າອັບເດດສະມາຊິກ.
ນີ້ຈະເພີ່ມ stubs ເອກະສານສໍາລັບການເພີ່ມປະເພດ, ແຕ່ຈະ ບໍ່ ຕື່ມຫຼືເອົາອອກ
ເອກະສານສໍາລັບສະມາຊິກຂອງປະເພດໃດກໍ່ຕາມ (ລວມທັງປະເພດທີ່ເພີ່ມ).
-importslashdoc:FILE
ເອກະສານ ເປັນໄຟລ໌ XML ທີ່ສ້າງຂຶ້ນດ້ວຍ /doc:FILE C# compiler flag (ຕ.ຢ mcs
-doc:foo.xml foo.cs ). ນຳເຂົ້າເອກະສານສະມາຊິກທີ່ບັນຈຸຢູ່ພາຍໃນ ເອກະສານ ເຂົ້າໄປໃນ
ຮູບແບບເອກະສານທີ່ໃຊ້ໂດຍ monodoc.
-ຊື່:NAME
NAME ແມ່ນຊື່ຂອງໂຄງການເອກະສານນີ້ແມ່ນສໍາລັບ.
ນີ້ກໍານົດ /ພາບລວມ/ຫົວຂໍ້ ອົງປະກອບພາຍໃນ index.xml ໄຟລ໌ທີ່ສ້າງຕັ້ງຂື້ນຢູ່ໃນ
ໄດເລກະທໍລີທີ່ລະບຸໂດຍ - ເສັ້ນທາງ . ນີ້ຖືກນໍາໃຊ້ໂດຍບາງໂຄງການສໍາລັບຂໍ້ມູນຫົວຂໍ້
(ຕົວຢ່າງ monodocs2html ).
-namespace:NAMESPACE
ພຽງແຕ່ປັບປຸງປະເພດພາຍໃນ namespace NAMESPACE .
- overrides
ລວມເອົາວິທີການ overridden ໃນເອກະສານ.
ປົກກະຕິອັນນີ້ບໍ່ຈຳເປັນ, ເພາະວ່າ Mono Documentation Browser ຈະສະໜອງໃຫ້
ເຊື່ອມຕໍ່ກັບສະມາຊິກປະເພດພື້ນຖານ, ຕາມທີ່ໃຈຈະ monodocs2html ຖ້າປະເພດພື້ນຖານແມ່ນ
ພາຍໃນສະພາແຫ່ງດຽວກັນ.
-ເສັ້ນທາງ:OUTPUT_DIR
OUTPUT_DIR ແມ່ນລະບົບທີ່ຈະປະກອບດ້ວຍ stubs ເອກະສານໃຫມ່ / ການປັບປຸງ.
-ງາມ
ຫຍໍ້ໜ້າໄຟລ໌ XML ໄດ້ດີ.
- ນັບຕັ້ງແຕ່: ນັບຕັ້ງແຕ່
ສ້າງ ກ ອົງປະກອບສໍາລັບການເພີ່ມປະເພດແລະສະມາຊິກທີ່ມີຄ່າ ນັບຕັ້ງແຕ່ .
ຕົວຢ່າງ, ເມື່ອໃຫ້ -ນັບຕັ້ງແຕ່:"Gtk# 2.4 " ອົງປະກອບຈະຖືກໃສ່ເຂົ້າໄປໃນ Docs
ອົງປະກອບສໍາລັບທຸກປະເພດທີ່ເພີ່ມແລະສະມາຊິກປະເພດ:
Mono Documentation Browser ແລະ monodocs2html ຈະໃຊ້ອົງປະກອບນີ້ເພື່ອລະບຸ
ໃນສະບັບໃດສະມາຊິກໄດ້ຖືກເພີ່ມ.
-type:TYPE
ພຽງແຕ່ສ້າງ / ປັບປຸງເອກະສານສໍາລັບປະເພດ TYPE .
-updateto:PATH
ໃນເວລາທີ່ການປັບປຸງເອກະສານ, ຂຽນໄຟລ໌ເອກະສານທີ່ປັບປຸງເຂົ້າໄປໃນ
ລະບົບ PATH .
-V, -ການປ່ຽນແປງ
ສະບັບສະແດງແລະຂໍ້ມູນໃບອະນຸຍາດ.
ລາຍລະອຽດ
monodocer ໄດ້ຖືກຍົກເລີກໂດຍ mdoc(1). ເບິ່ງ mdoc-ອັບເດດ(1) ຫນ້າຜູ້ຊາຍ.
monodocer ແມ່ນໂຄງການທີ່ສ້າງເອກະສານເອກະສານ XML ໃນເອກະສານ ECMA
ຮູບແບບ. ມັນບໍ່ໄດ້ອີງໃສ່ເອກະສານທີ່ພົບເຫັນຢູ່ໃນລະຫັດແຫຼ່ງ.
ຂໍ້ດີແມ່ນ:
* ລະຫັດ ຄວາມສາມາດອ່ານໄດ້. ເອກະສານທີ່ດີແມ່ນເລື້ອຍໆ (a) verbose, ແລະ (b) ເຕັມໄປ
ມີຕົວຢ່າງ. (ສໍາລັບການປຽບທຽບ, ປຽບທຽບເອກະສານ Microsoft .NET Framework,
ເຊິ່ງມັກຈະເປັນໜ້າ ຫຼືຫຼາຍເອກະສານສຳລັບສະມາຊິກແຕ່ລະຄົນ, ໄປຫາເອກະສານ JavaDoc,
ເຊິ່ງມັກຈະເປັນປະໂຫຍກສຳລັບສະມາຊິກແຕ່ລະຄົນ.)
ການໃສ່ເອກະສານທີ່ດີເຂົ້າໄປໃນລະຫັດແຫຼ່ງມັກຈະເຮັດໃຫ້ແຫຼ່ງທີ່ມາ
ໄຟລ໌, ເນື່ອງຈາກວ່າເອກະສານສາມາດຍາວກວ່າວິທີການຕົວຈິງທີ່ເປັນ
documented.
* ທ້ອງຖິ່ນ. ຮູບແບບເອກະສານໃນແຫຼ່ງ (ເຊັ່ນ: /doc ) ບໍ່ມີສະຫນັບສະຫນູນສໍາລັບການ
ຫຼາຍພາສາຂອງມະນຸດ. ຖ້າຫາກວ່າທ່ານຕ້ອງການທີ່ຈະສະຫນັບສະຫນູນຫຼາຍກ່ວາຫນຶ່ງພາສາຂອງມະນຸດສໍາລັບການ
ຈຸດປະສົງເອກະສານ, monodocer ເປັນປະໂຫຍດຍ້ອນວ່າມັນອະນຸຍາດໃຫ້ແຕ່ລະພາສາໄດ້ຮັບມັນ
ໄດເລກະທໍລີຂອງຕົນເອງ, ແລະ monodocer ສາມາດເພີ່ມປະເພດ/ສະມາຊິກສຳລັບແຕ່ລະເອກະສານແຍກຕ່າງຫາກ
ລະບົບ.
* ການບໍລິຫານ. ມັນບໍ່ຜິດປົກກະຕິທີ່ຈະມີເອກະສານແລະການພັດທະນາແຍກຕ່າງຫາກ
ທີມ. ມັນຍັງເປັນໄປໄດ້ວ່າທີມງານເອກະສານຈະມີປະສົບການຫນ້ອຍທີ່ສຸດ
ກັບພາສາການຂຽນໂປລແກລມຖືກນໍາໃຊ້. ໃນສະຖານະການດັ່ງກ່າວ, inline
ເອກະສານບໍ່ເປັນທີ່ຕ້ອງການ ເນື່ອງຈາກທີມງານເອກະສານສາມາດໃສ່ໄດ້ໂດຍບໍ່ໄດ້ຕັ້ງໃຈ
ເກີດຄວາມຜິດພາດໃນລະຫັດແຫຼ່ງໃນຂະນະທີ່ການປັບປຸງເອກະສານ. ອີກທາງເລືອກ, ທ່ານ
ອາດຈະບໍ່ຢາກໃຫ້ທີມງານເອກະສານມີການເຂົ້າເຖິງລະຫັດແຫຼ່ງເພື່ອຄວາມປອດໄພ
ເຫດຜົນ. monodocer ອະນຸຍາດໃຫ້ເກັບຮັກສາເອກະສານ ສົມບູນ ແຍກຕ່າງຫາກແລະ
ແຕກຕ່າງຈາກລະຫັດແຫຼ່ງທີ່ໃຊ້ເພື່ອສ້າງການປະກອບ.
ເພື່ອເຮັດໃຫ້ການ monodocer ເອກະສານເຂົ້າໄປໃນບາງສິ່ງບາງຢ່າງທີ່ສາມາດໄດ້ຮັບການບໍລິໂພກໂດຍ Mono
Documentation Browser (ຕົວທ່ອງເວັບຊ່ວຍເຫຼືອ desktop, ຫຼືຕົວເຊື່ອມຕໍ່ເວັບສໍາລັບມັນ) ມັນແມ່ນ
ມີຄວາມຈໍາເປັນເພື່ອລວບລວມເອກະສານເຂົ້າໄປໃນຮູບແບບບັນຈຸ. ນີ້ແມ່ນເຮັດໄດ້ກັບ
ເຄື່ອງມື mdassembler, ສໍາລັບຕົວຢ່າງ, ທ່ານສາມາດນໍາໃຊ້ລະບົບຕ່ອງໂສ້ເຄື່ອງມືເຊັ່ນນີ້:
$ monodocer -assembly:MyWidgets -path:generated_docs
$ mdassembler --ecma generated_docs -out:MyWidgets
ຂ້າງເທິງຈະສ້າງ MyWidgets.zip ແລະ MyWidgets.tree ທີ່ສາມາດຕິດຕັ້ງໄດ້.
ໃນລະບົບ. ນອກເໜືອໄປຈາກສອງໄຟລ໌ (.zip ແລະ .tree) ທ່ານຕ້ອງສະໜອງ .sources
ໄຟລ໌ທີ່ອະທິບາຍບ່ອນທີ່ຢູ່ໃນລະບົບການຊ່ວຍເຫຼືອ, ເອກະສານຄວນຈະຖືກເຊື່ອມຕໍ່, ມັນແມ່ນ
ໄຟລ໌ XML ງ່າຍດາຍຫຼາຍ, ເຊັ່ນນີ້:
ໄຟລ໌ການຕັ້ງຄ່າຂ້າງເທິງອະທິບາຍວ່າເອກະສານແມ່ນຢູ່ໃນຮູບແບບ ECMA (the
ສະບັບທີ່ລວບລວມ) ວ່າຊື່ໄຟລ໌ພື້ນຖານແມ່ນ MyWidgets ແລະວ່າມັນຄວນຈະຖືກຕິດຢູ່ໃນ
ສ່ວນ "classlib-gnome" ຂອງຕົ້ນໄມ້. ຖ້າທ່ານຕ້ອງການເບິ່ງຂໍ້ຕ່າງໆທີ່ກໍານົດໄວ້
ໃນເອກະສານ, ທ່ານສາມາດເບິ່ງໄຟລ໌ monodoc.xml ເຊິ່ງມັກຈະຖືກຕິດຕັ້ງຢູ່ໃນ
/usr/lib/monodoc/monodoc.xml.
ເມື່ອເຈົ້າມີໄຟລ໌ທັງໝົດຂອງເຈົ້າ (.zip, .tree ແລະ .sources) ເຈົ້າສາມາດຕິດຕັ້ງພວກມັນໃສ່ໄດ້.
ລະບົບທີ່ມີຄໍາສັ່ງດັ່ງຕໍ່ໄປນີ້:
$ cp MyWidgets.tree MyWidgets.zip MyWidgets.source `pkg-config monodoc --variable sourcesdir`
ຂ້າງເທິງນີ້ຈະຄັດລອກໄຟລ໌ເຂົ້າໄປໃນໄດເລກະທໍລີທີ່ Monodoc ໄດ້ລົງທະບຽນ (ທ່ານອາດຈະ
ຕ້ອງການສິດຮາກເພື່ອເຮັດສິ່ງນີ້). ໄດເລກະທໍລີຕົວຈິງຖືກສົ່ງຄືນໂດຍ pkg-config
ຄຳຮຽກຮ້ອງ.
ຄັກ ID ຮູບແບບ
String IDs ແມ່ນໃຊ້ເພື່ອອ້າງອີງເຖິງປະເພດ ຫຼືສະມາຊິກຂອງປະເພດໃດນຶ່ງ. ລະຫັດສະຕຣິງຖືກບັນທຶກໄວ້ໃນ
ECMA-334 ສະບັບທີ 3, ເອກະສານຊ້ອນທ້າຍ E.3.1. ພວກເຂົາເຈົ້າປະກອບດ້ວຍ a ສະມາຊິກ ປະເພດ ຄຳ ນຳ ໜ້າ , ປະເພດເຕັມ
name (namespace + ຊື່, ແຍກດ້ວຍ '.'), ອາດຈະຕິດຕາມດ້ວຍຊື່ສະມາຊິກແລະອື່ນໆ
ຂໍ້ມູນຂ່າວສານ.
ຄຳນຳໜ້າປະເພດສະມາຊິກ:
E: String ID ຫມາຍເຖິງເຫດການ. ຊື່ເຫດການປະຕິບັດຕາມຊື່ປະເພດ:
E:System.AppDomain.AssemblyLoad
F: String ID ຫມາຍເຖິງຊ່ອງຂໍ້ມູນ. ຊື່ພາກສະຫນາມປະຕິບັດຕາມຊື່ປະເພດ:
F:System.Runtime.InteropServices.DllImportAttribute.SetLastError
M: ຫມາຍເຖິງຜູ້ສ້າງຫຼືວິທີການ. ຜູ້ກໍ່ສ້າງຕໍ່ທ້າຍ .ctor ກັບຊື່ປະເພດ,
ໃນຂະນະທີ່ວິທີການເພີ່ມເຕີມຊື່ວິທີການ (ດ້ວຍການນັບທາງເລືອກຂອງຈໍານວນຂອງ
ຕົວກໍານົດການທົ່ວໄປ).
ຖ້າຜູ້ສ້າງຫຼືວິທີການໃຊ້ການໂຕ້ຖຽງ, ສິ່ງເຫຼົ່ານີ້ຖືກລະບຸໄວ້ໃນ paranthesis
ຫຼັງຈາກຊື່ຜູ້ສ້າງ/ວິທີການ:
M:System.Object..ctor , M:System.String..ctor(System.Char[]) ,
M:System.String.Concat(System.Object) , M:System.Array.Sort``1(``0[]) ,
M:System.Collections.Generic.List`1..ctor ,
M:System.Collections.Generic.List`1.Add(`0) .
N: ຫມາຍເຖິງ namespace, eg N: ລະບົບ
P: ຫມາຍເຖິງຊັບສິນ. ຖ້າຊັບສິນແມ່ນຕົວດັດສະນີຫຼືໃຊ້ຕົວກໍານົດການ, the
ປະເພດຂອງພາລາມິເຕີຖືກຕໍ່ທ້າຍກັບຊື່ຊັບສິນແລະຖືກຫຸ້ມດ້ວຍ paranthesis:
P:System.String.Length , P:System.String.Chars(System.Int32) .
T: String ID ໝາຍເຖິງປະເພດໃດໜຶ່ງ, ໂດຍມີຈຳນວນປະເພດທົ່ວໄປຕໍ່ທ້າຍ:
T:System.String , T:System.Collections.Generic.List`1
ເພື່ອເຮັດໃຫ້ເລື່ອງທີ່ຫນ້າສົນໃຈຫຼາຍ, ປະເພດທົ່ວໄປ & ສະມາຊິກມີສອງຕົວແທນ: ໄດ້
"unbound" ການເປັນຕົວແທນ (ສະແດງຢູ່ໃນຕົວຢ່າງຂ້າງເທິງ), ເຊິ່ງຊື່ຫ້ອງຮຽນມີຈໍານວນ
ຕົວກໍານົດການທົ່ວໄປຕໍ່ທ້າຍຊື່ຂອງເຂົາເຈົ້າ. ນອກຈາກນີ້ຍັງມີການເປັນຕົວແທນ "ຜູກມັດ", ໃນ
ເຊິ່ງການຜູກມັດຂອງຕົວກໍານົດການທົ່ວໄປແມ່ນລະບຸໄວ້ພາຍໃນ '{' ແລະ '}'.
ບໍ່ໄດ້ຜູກມັດ: T:System.Collections.Generic.List`1 , T:System.Collections.Generic.Dictionary`2 .
ຜູກມັດ: T:System.Collections.Generic.List{System.Int32}
T:System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.Predicate{System.String}}}
.
ດັ່ງທີ່ເຈົ້າສາມາດເຫັນໄດ້, ຕົວແປທີ່ຜູກມັດສາມາດສັບສົນໄດ້ (ຄືກັນກັບແບບທົ່ວໄປ).
ຍິ່ງໄປກວ່ານັ້ນ, ຖ້າຕົວກໍານົດການທົ່ວໄປຖືກຜູກມັດກັບພາລາມິເຕີທົ່ວໄປຂອງປະເພດຫຼືວິທີການ,
"ດັດຊະນີ" ຂອງຕົວກໍານົດການທົ່ວໄປຂອງປະເພດ / ວິທີການແມ່ນຖືກນໍາໃຊ້ເປັນການຜູກມັດ, ດັ່ງນັ້ນ
ປະເພດ FooType {
ສາທາລະນະ static void Foo (ລະບົບ. Predicate predicate) {}
}
String ID ສໍາລັບວິທີການນີ້ແມ່ນ M:FooType.Foo``1(System.Predicate{``0}) , as ``0 ເປັນ
ດັດຊະນີພາຣາມິເຕີທົ່ວໄປທີ 0 ທີ່ຜູກມັດກັບ System.Predicate .
ເອກະສານອ້າງອີງ ຮູບແບບ
monodocer ສ້າງເອກະສານທີ່ຄ້າຍຄືກັນກັບຮູບແບບເອກະສານ Ecma, ດັ່ງທີ່ໄດ້ອະທິບາຍ
ໃນ ECMA-335 3rd Edition, Partition IV, ບົດທີ 7.
ຄວາມແຕກຕ່າງຕົ້ນຕໍຈາກຮູບແບບ ECMA ແມ່ນວ່າແຕ່ລະປະເພດໄດ້ຮັບໄຟລ໌ຂອງຕົນເອງ, ພາຍໃນ
ໄດເລກະທໍລີທີ່ຄ້າຍຄືກັບ namespace ຂອງປະເພດ.
ຂໍ້ມູນສ່ວນໃຫຍ່ພາຍໃນເອກະສານຄວນ ບໍ່ ຖືກແກ້ໄຂ. ນີ້ປະກອບມີ
ປະເພດຊື່ ( /Type/@FullName ), ການໂຕ້ຕອບທີ່ປະຕິບັດ ( /ປະເພດ/ການໂຕ້ຕອບ ), ສະມາຊິກ
ຂໍ້ມູນ ( /Type/Member/Member/@MemberName , /ປະເພດ/ສະມາຊິກ/ສະມາຊິກ/ລາຍເຊັນສະມາຊິກ ,
/Type/Member/Member/MemberType , /Type/Member/Member/Parameters , ຯ ລະຯ )
ແມ່ນຫຍັງ ຄວນ ໄດ້ຮັບການດັດແກ້ແມ່ນອົງປະກອບທັງຫມົດທີ່ມີຂໍ້ຄວາມ To be ເພີ່ມ , ເຊິ່ງປະຈຸບັນ
ພາຍໃຕ້ການ // ເອກະສານ ອົງປະກອບ (ຕົວຢ່າງ /ປະເພດ/ເອກະສານ , /Type/Member/Member/Docs ). ເນື້ອໃນ
ຂອງ Docs ອົງປະກອບແມ່ນ ດຽວກັນ ໃນ semantics ແລະໂຄງສ້າງຂອງເອກະສານ C# inline
ຮູບແບບ, ປະກອບດ້ວຍອົງປະກອບເຫຼົ່ານີ້ (ລະບຸໄວ້ໃນ ECMA-334 ສະບັບທີ 3, ເອກະສານຊ້ອນທ້າຍ E, ພາກທີ 2).
ຕໍ່ໄປນີ້ແມ່ນໃຊ້ຢູ່ໃນຄໍາອະທິບາຍອົງປະກອບ:
CREF ອ້າງອີງເຖິງຫ້ອງຮຽນ (ຫຼືສະມາຊິກ) ອ້າງອີງ, ແລະເປັນສະຕຣິງໃນຮູບແບບທີ່ອະທິບາຍ
ຂ້າງເທິງໃນ ຄັກ ID ຮູບແບບ ສ່ວນ.
ຂໍ້ຄວາມ ຂໍ້ຄວາມທີ່ບໍ່ແມ່ນ XML, ແລະ XML ບໍ່ຄວນຖືກວາງໄວ້.
XML ພຽງແຕ່ອົງປະກອບ XML ຄວນຖືກວາງໄວ້ (ເຊິ່ງໂດຍທາງອ້ອມອາດມີຂໍ້ຄວາມ), ແຕ່ບໍ່ແມ່ນ.
ຂໍ້ຄວາມຊ່ອງຫວ່າງບໍ່ຄວນເປັນ node ເດັກນ້ອຍໃນທັນທີ.
XML_TEXT
ຂໍ້ຄວາມຮູບແບບຟຣີ ແລະ XML, ດັ່ງນັ້ນອົງປະກອບ XML ອື່ນໆອາດຈະຖືກຊ້ອນກັນ.
ອົງປະກອບຕໍ່ໄປນີ້ແມ່ນໃຊ້ໃນເອກະສານ:
<ບລັອກ subset="SUBSET" type="TYPE">XML_TEXT
ສ້າງບລັອກຂອງຂໍ້ຄວາມ, ຄ້າຍຄືກັນໃນແນວຄວາມຄິດຂອງວັກ, ແຕ່ຖືກນໍາໃຊ້ເພື່ອສ້າງ
ການແບ່ງແຍກພາຍໃນຂໍ້ຄວາມ. ໃນບາງຂອບເຂດ, ກ ເທົ່າກັບ HTML
ແທັກ.
SUBSET ຄວນເປັນມູນຄ່າສະເໝີ none .
TYPE ລະບຸຫົວຂໍ້ ແລະຮູບແບບທີ່ຈະໃຊ້. ປະເພດທີ່ໄດ້ຮັບການຍອມຮັບແມ່ນ:
ພຶດຕິກໍາຕ່າງໆ ສ້າງພາກສ່ວນທີ່ມີຫົວຂໍ້ ການດໍາເນີນງານ .
ຫມາຍເຫດ ສ້າງພາກສ່ວນທີ່ມີຫົວຂໍ້ ຫມາຍເຫດ: .
overrides ສ້າງພາກສ່ວນທີ່ມີຫົວຂໍ້ ຫມາຍເຫດ to ຜູ້ສືບທອດ .
ການນໍາໃຊ້ ສ້າງພາກສ່ວນທີ່ມີຫົວຂໍ້ ການນໍາໃຊ້ .
XML_TEXT
ກໍານົດຂໍ້ຄວາມໃນຕົວອັກສອນທີ່ຄ້າຍຄືກັບລະຫັດ (ຄ້າຍກັບ ອົງປະກອບ HTML ).
<ລະຫັດ lang="LANGUAGE">ຂໍ້ຄວາມ
ສະແດງຂໍ້ຄວາມຫຼາຍແຖວໃນຕົວອັກສອນທີ່ຄ້າຍຄືກັບລະຫັດ (ຄ້າຍກັບ HTML
ອົງປະກອບ). LANGUAGE ແມ່ນພາສາທີ່ບລັອກລະຫັດນີ້ແມ່ນສໍາລັບ. ຕົວຢ່າງ, ຖ້າ
LANGUAGE is C# , ຫຼັງຈາກນັ້ນ ຂໍ້ຄວາມ ຈະໄດ້ຮັບການເນັ້ນໃສ່ syntax ສໍາລັບພາສາ C# ພາຍໃນ
Mono Documentation Browser.
XML_TEXT
ຊີ້ໃຫ້ເຫັນຕົວຢ່າງທີ່ຄວນຈະຖືກສະແດງເປັນພິເສດ. ຍົກຕົວຢ່າງ:
ວັກແນະນໍາ.
ຕົວຢ່າງຫ້ອງຮຽນ {
public static void Main ()
{
System.Console.WriteLine("ສະບາຍດີ, ໂລກ!");
}
}
<ຂໍ້ຍົກເວັ້ນ cref="CREF">XML_TEXT
ກໍານົດຂໍ້ຍົກເວັ້ນທີ່ສາມາດຖືກຖິ້ມໂດຍສະມາຊິກເອກະສານ.
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
CREF ແມ່ນປະເພດຂໍ້ຍົກເວັ້ນທີ່ຖືກຖິ້ມ, ໃນຂະນະທີ່ XML_TEXT ປະກອບດ້ວຍ
ສະຖານະການທີ່ຈະເຮັດໃຫ້ເກີດ CREF ຈະຖືກຖິ້ມ.
ແມ່ນ .
XML
ສ້າງບັນຊີລາຍຊື່ຫຼືຕາຕະລາງຂອງລາຍການ. ເຮັດໃຫ້ການນໍາໃຊ້ຂອງຮັງ XML ,
XML , XML_TEXT , ແລະ
XML_TEXT ອົງປະກອບ.
ລາຍການ ມີ syntax:
ລູກປືນ 1
ລູກປືນ 2
ລູກປືນ 3
ຕາຕະລາງ ມີ syntax:
ຖັນ 1
ຖັນ 2
ຖັນ 3
ລາຍການ 1-A
ລາຍການ 1-B
ລາຍການ 1-C
ລາຍການ 2-A
ລາຍການ 2-B
ລາຍການ 2-C
XML_TEXT
ໃສ່ວັກຂອງ XML_TEXT
. ນີ້ແມ່ນສໍາລັບການນໍາໃຊ້ພາຍໃນ tags ອື່ນໆ, ເຊັ່ນ: , ,
, ແລະ (ເບິ່ງ , ຂ້າງເທິງ), ແລະອົງປະກອບອື່ນໆຫຼາຍທີ່ສຸດ.
ຍົກຕົວຢ່າງ,
ນີ້ແມ່ນວັກຂອງຂໍ້ຄວາມ.
<param name="NAME">XML_TEXT
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ອະທິບາຍພາລາມິເຕີ NAME ຂອງຜູ້ກໍ່ສ້າງ, ວິທີການ, ຫຼືຊັບສິນໃນປະຈຸບັນ:
ກ ປະກອບມີຈໍານວນ
ຂອງ widget ທີ່ຈະປະມວນຜົນ.
<paramref name="NAME" />
ຊີ້ໃຫ້ເຫັນວ່າ NAME ແມ່ນຕົວກໍານົດການ.
ນີ້ປົກກະຕິແລ້ວ renders NAME ເປັນຕົວໜັງສືຕົວອຽງ, ສະນັ້ນມັນມັກ (ab) ຖືກນໍາໃຊ້ເປັນ
ເທົ່າກັບ ອົງປະກອບ HTML . ເບິ່ງ ເອກະສານ (ຂ້າງເທິງ)
ຕົວຢ່າງ.
<ອະນຸຍາດ cref="CREF">XML_TEXT
ບັນທຶກຄວາມຕ້ອງການເຂົ້າເຖິງຄວາມປອດໄພຂອງສະມາຊິກປະຈຸບັນ.
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
CREF ແມ່ນປະເພດການອ້າງອີງເຖິງການອະນຸຍາດຄວາມປອດໄພທີ່ຕ້ອງການ, ໃນຂະນະທີ່ XML_TEXT ເປັນ
ລາຍລະອຽດວ່າເປັນຫຍັງຕ້ອງການການອະນຸຍາດ.
ຮຽກຮ້ອງໃຫ້ມີການອະນຸຍາດສໍາລັບການອ່ານແລະຂຽນໄຟລ໌. ເບິ່ງ
,
.
XML_TEXT
ປະກອບມີຂໍ້ມູນລະອຽດກ່ຽວກັບສະມາຊິກ.
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ໃສ່ຂໍ້ມູນລະອຽດໃສ່ບ່ອນນີ້.
XML_TEXT
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ອະທິບາຍຄ່າກັບຄືນຂອງວິທີການ:
ກ ລະບຸວ່າ
ຫຼືບໍ່ຂະບວນການສາມາດເຂົ້າເຖິງໄດ້
.
<ເບິ່ງ cref="CREF" />
ສ້າງລິ້ງໄປຫາສະມາຊິກທີ່ລະບຸພາຍໃນຂໍ້ຄວາມປັດຈຸບັນ:
<ເຫັນດ້ວຍ cref="CREF" />
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ອະນຸຍາດໃຫ້ສ້າງລາຍການເຂົ້າສໍາລັບ ເບິ່ງ ນອກຈາກນີ້ຍັງ ຂໍ້ຍ່ອຍ. ໃຊ້ ກໍານົດ
ການເຊື່ອມຕໍ່ຈາກພາຍໃນຂໍ້ຄວາມ.
<ຕັ້ງແຕ່ version="VERSION" />
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ອະນຸຍາດໃຫ້ສະເພາະຂອງສະບັບທີ່ນໍາສະເຫນີປະເພດທີ່ກໍານົດໄວ້ຫຼືສະມາຊິກ.
ຄຳອະທິບາຍ
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ສະເໜີພາບລວມ (ໂດຍຫຍໍ້!) ກ່ຽວກັບປະເພດ ຫຼືສະມາຊິກປະເພດ.
ອັນນີ້ມັກຈະສະແດງເປັນສ່ວນໜຶ່ງຂອງການປະກາດຊັ້ນຮຽນ, ແລະຄວນຈະເປັນ
ລາຍລະອຽດສັ້ນສົມເຫດສົມຜົນຂອງປະເພດ/ສະມາຊິກ. ໃຊ້ ສໍາລັບລາຍລະອຽດເພີ່ມເຕີມ
ຂໍ້ມູນຂ່າວສານ.
<typeparam name="NAME">ລາຍລະອຽດ
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ນີ້ຖືກນໍາໃຊ້ເພື່ອອະທິບາຍພາລາມິເຕີປະເພດສໍາລັບປະເພດທົ່ວໄປຫຼືວິທີການທົ່ວໄປ.
NAME ແມ່ນຊື່ຂອງຕົວກໍານົດການປະເພດ, ໃນຂະນະທີ່ ລາຍລະອຽດ ປະກອບດ້ວຍຄໍາອະທິບາຍຂອງ
ພາລາມິເຕີ (ສິ່ງທີ່ມັນໃຊ້ສໍາລັບ, ສິ່ງທີ່ຈໍາກັດມັນຕ້ອງຕອບສະຫນອງ, ແລະອື່ນໆ).
ປະເພດຂອງການເກັບກໍາທີ່ຕິດພັນ
ໃຊ້ເພື່ອຊີ້ບອກວ່າຄຳສັບໃດໜຶ່ງເປັນພາລາມິເຕີປະເພດ, ສຳລັບໃຊ້ພາຍໃນຕົວໜັງສືອື່ນໆ
(ເຊັ່ນ: ພາຍໃນ ).
ຖ້າ ແມ່ນໂຄງສ້າງ, ຫຼັງຈາກນັ້ນ ...
ຄຳອະທິບາຍ
ເປັນອົງປະກອບລະດັບເທິງ, ແລະຄວນຈະຖືກ nested ໂດຍກົງພາຍໃຕ້ການ
ອົງປະກອບ.
ອະນຸຍາດໃຫ້ອະທິບາຍຊັບສິນ.
ກ ປະກອບມີຊື່ widget.
ໃຊ້ monodocer ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net
