മോണോഡോസർ - ഓൺലൈനിൽ ക്ലൗഡിൽ

പട്ടിക:

NAME

monodocer - ECMA ഡോക്യുമെന്റേഷൻ ഫോർമാറ്റ് പിന്തുണ

സിനോപ്സിസ്

മോണോഡോസർ [ഓപ്ഷനുകൾ]*

ഓപ്ഷനുകൾ

-അസംബ്ലി:അസംബ്ലി
അസംബ്ലി ഡോക്യുമെന്റേഷൻ സ്റ്റബുകൾ സൃഷ്ടിക്കുന്നതിനുള്ള ഒരു .NET അസംബ്ലിയാണ്.

ഒരു ഫയൽ പാതയോ GAC'd അസംബ്ലിയുടെ പേരോ വ്യക്തമാക്കുക.

-ഇല്ലാതാക്കുക
ഡോക്യുമെന്റേഷൻ ഫയലുകളിൽ നിന്ന് അംഗങ്ങളെ ഇല്ലാതാക്കാൻ മോണോഡോസറിനെ അനുവദിക്കുക. അംഗങ്ങൾ മാത്രം
സഭയിൽ ഇനി ഹാജരാകാത്ത അംഗങ്ങൾക്കുള്ളതാണ് ഇല്ലാതാക്കിയത്.

ഒരു തരം ഇനി ഇല്ലെങ്കിൽ, ഡോക്യുമെന്റേഷൻ ഫയൽ ആണ് അല്ല ഇല്ലാതാക്കി, പക്ഷേ
പകരം പുനർനാമകരണം ചെയ്തു ഒരു ഉണ്ട് .നീക്കം ചെയ്യുക വിപുലീകരണം.

-?, -ഹെൽപ്പ്
പ്രോഗ്രാം ആർഗ്യുമെന്റ് വിവരങ്ങൾ കാണിക്കുക.

-അജ്ഞർ
അംഗങ്ങളെ അപ്ഡേറ്റ് ചെയ്യരുത്.

ഇത് ചേർത്ത തരങ്ങൾക്കായി ഡോക്യുമെന്റേഷൻ സ്റ്റബുകൾ ചേർക്കും, പക്ഷേ ചെയ്യും അല്ല ചേർക്കുക അല്ലെങ്കിൽ നീക്കം ചെയ്യുക
ഏതെങ്കിലും തരത്തിലുള്ള ഏതെങ്കിലും അംഗങ്ങൾക്കുള്ള ഡോക്യുമെന്റേഷൻ (ചേർത്ത ഏതെങ്കിലും തരങ്ങൾ ഉൾപ്പെടെ).

-importslashdoc:FILE
FILE ഉപയോഗിച്ച് സൃഷ്ടിച്ച ഒരു XML ഫയലാണ് /doc:FILE C# കംപൈലർ ഫ്ലാഗ് (ഉദാ mcs
-doc:foo.xml foo.cs ). ഉള്ളിൽ അടങ്ങിയിരിക്കുന്ന അംഗ ഡോക്യുമെന്റേഷൻ ഇറക്കുമതി ചെയ്യുക FILE കടന്നു
മോണോഡോക് ഉപയോഗിക്കുന്ന ഡോക്യുമെന്റേഷൻ ഫോർമാറ്റ്.

-പേര്:NAME
NAME ഈ ഡോക്യുമെന്റേഷൻ പ്രോജക്റ്റിന്റെ പേരാണ്.

ഇത് സജ്ജമാക്കുന്നു /അവലോകനം/ശീർഷകം ഉള്ളിലെ ഘടകം index.xml എന്നതിൽ ഫയൽ സൃഷ്ടിച്ചു
വ്യക്തമാക്കിയ ഡയറക്ടറി -പാത . ശീർഷക വിവരങ്ങൾക്കായി ചില പ്രോഗ്രാമുകൾ ഇത് ഉപയോഗിക്കുന്നു
(ഉദാ monodocs2html ).

-നാംസ്പെയ്സ്:NAMESPACE
നെയിംസ്‌പെയ്‌സിനുള്ളിലെ തരങ്ങൾ മാത്രം അപ്‌ഡേറ്റ് ചെയ്യുക NAMESPACE .

- അസാധുവാക്കുന്നു
ഡോക്യുമെന്റേഷനിൽ അസാധുവായ രീതികൾ ഉൾപ്പെടുത്തുക.

മോണോ ഡോക്യുമെന്റേഷൻ ബ്രൗസർ നൽകുന്നതിനാൽ ഇത് സാധാരണയായി ആവശ്യമില്ല
ഏതുവിധേനയും അടിസ്ഥാന തരം അംഗങ്ങളിലേക്ക് ലിങ്ക് ചെയ്യുക monodocs2html അടിസ്ഥാന തരം ആണെങ്കിൽ
ഒരേ അസംബ്ലിക്കുള്ളിൽ.

-പാത:OUTPUT_DIR
OUTPUT_DIR പുതിയ/അപ്‌ഡേറ്റ് ചെയ്‌ത ഡോക്യുമെന്റേഷൻ സ്റ്റബുകൾ ഉൾക്കൊള്ളുന്ന ഡയറക്ടറിയാണ്.

- മനോഹരം
XML ഫയലുകൾ നന്നായി ഇൻഡന്റ് ചെയ്യുക.

-മുതൽ:SINCE
സൃഷ്ടിക്കുക ചേർത്ത തരങ്ങൾക്കും മൂല്യമുള്ള അംഗങ്ങൾക്കുമുള്ള ഘടകം മുതലുള്ള .

ഉദാഹരണത്തിന്, നൽകുമ്പോൾ -മുതൽ:"Gtk# ക്സനുമ്ക്സ " എന്നതിലേക്ക് ഒരു ഘടകം ചേർക്കും ഡോക്സ്
ചേർത്ത എല്ലാ തരങ്ങൾക്കും തരം അംഗങ്ങൾക്കുമുള്ള ഘടകം:

മോണോ ഡോക്യുമെന്റേഷൻ ബ്രൗസറും monodocs2html വ്യക്തമാക്കാൻ ഈ ഘടകം ഉപയോഗിക്കും
ഏത് പതിപ്പിലാണ് ഒരു അംഗത്തെ ചേർത്തത്.

-തരം:TYPE
തരത്തിനായി മാത്രം ഡോക്യുമെന്റേഷൻ സൃഷ്‌ടിക്കുക/അപ്‌ഡേറ്റ് ചെയ്യുക തരം .

-updateto:PATH
ഡോക്യുമെന്റേഷൻ അപ്ഡേറ്റ് ചെയ്യുമ്പോൾ, അപ്ഡേറ്റ് ചെയ്ത ഡോക്യുമെന്റേഷൻ ഫയലുകൾ ഇതിലേക്ക് എഴുതുക
ഡയറക്ടറി PATH .

-വി, -പതിപ്പ്
പതിപ്പും ലൈസൻസിംഗ് വിവരങ്ങളും പ്രദർശിപ്പിക്കുക.

വിവരണം

മോണോഡോസർ വഴി കാലഹരണപ്പെട്ടിരിക്കുന്നു mdoc(1). കാണുക mdoc-update(1) മാൻ പേജ്.

മോണോഡോസർ ECMA ഡോക്യുമെന്റേഷനിൽ XML ഡോക്യുമെന്റേഷൻ സ്റ്റബുകൾ സൃഷ്ടിക്കുന്ന ഒരു പ്രോഗ്രാമാണ്
ഫോർമാറ്റ്. ഇത് സോഴ്സ് കോഡിനുള്ളിൽ കാണുന്ന ഡോക്യുമെന്റേഷനെ ആശ്രയിക്കുന്നില്ല.

ഗുണങ്ങൾ ഇവയാണ്:

* കോഡ് വായനാക്ഷമത. നല്ല ഡോക്യുമെന്റേഷൻ ഇടയ്ക്കിടെ (എ) വാചാലവും (ബി) നിറഞ്ഞതുമാണ്
ഉദാഹരണങ്ങൾ സഹിതം. (താരതമ്യത്തിനായി, Microsoft .NET ഫ്രെയിംവർക്ക് ഡോക്യുമെന്റേഷൻ താരതമ്യം ചെയ്യുക,
ഇത് പലപ്പോഴും ഓരോ അംഗത്തിനും ഒരു പേജോ അതിലധികമോ ഡോക്‌സുകളാണ്, JavaDoc ഡോക്യുമെന്റേഷനിലേക്ക്,
ഇത് പലപ്പോഴും ഓരോ അംഗത്തിനും ഒരു വാക്യമായിരിക്കാം.)

സോഴ്‌സ് കോഡിലേക്ക് നല്ല ഡോക്യുമെന്റേഷൻ ചേർക്കുന്നത് ഉറവിടത്തെ ഇടയ്ക്കിടെ വീർപ്പിക്കും
ഫയൽ, ഡോക്യുമെന്റേഷൻ യഥാർത്ഥ രീതിയേക്കാൾ ദൈർഘ്യമേറിയതായിരിക്കാം
രേഖപ്പെടുത്തി.

* പ്രാദേശികവൽക്കരണം. ഇൻ-സോഴ്സ് ഡോക്യുമെന്റേഷൻ ഫോർമാറ്റുകൾ (ഉദാ /ഡോക് ) എന്നതിന് പിന്തുണയില്ല
ഒന്നിലധികം മനുഷ്യ ഭാഷകൾ. നിങ്ങൾക്ക് ഒന്നിലധികം മനുഷ്യ ഭാഷകളെ പിന്തുണയ്‌ക്കണമെങ്കിൽ
ഡോക്യുമെന്റേഷൻ ഉദ്ദേശ്യങ്ങൾ, മോണോഡോസർ ഓരോ ഭാഷയ്ക്കും അത് ലഭിക്കാൻ അനുവദിക്കുന്നതിനാൽ ഉപയോഗപ്രദമാണ്
സ്വന്തം ഡയറക്ടറി, ഒപ്പം മോണോഡോസർ ഓരോ പ്രത്യേക ഡോക്യുമെന്റേഷനും തരങ്ങൾ/അംഗങ്ങൾ ചേർക്കാൻ കഴിയും
ഡയറക്ടറി.

* ഭരണകൂടം. പ്രത്യേക ഡോക്യുമെന്റേഷനും വികസനവും ഉള്ളത് അസാധാരണമല്ല
ടീമുകൾ. ഡോക്യുമെന്റേഷൻ ടീമിന് കുറഞ്ഞ അനുഭവം ഉണ്ടായിരിക്കാനും സാധ്യതയുണ്ട്
പ്രോഗ്രാമിംഗ് ഭാഷ ഉപയോഗിച്ച്. അത്തരം സാഹചര്യങ്ങളിൽ, ഇൻലൈൻ
ഡോക്യുമെന്റേഷൻ ടീമിന് അശ്രദ്ധമായി തിരുകാൻ കഴിയുന്നതിനാൽ ഡോക്യുമെന്റേഷൻ അഭികാമ്യമല്ല
ഡോക്യുമെന്റേഷൻ അപ്ഡേറ്റ് ചെയ്യുമ്പോൾ സോഴ്സ് കോഡിൽ ഒരു പിശക്. പകരമായി, നിങ്ങൾ
ഡോക്യുമെന്റേഷൻ ടീമിന് സുരക്ഷയ്ക്കായി സോഴ്സ് കോഡിലേക്ക് ആക്സസ് ഉണ്ടാകണമെന്നില്ല
കാരണങ്ങൾ. മോണോഡോസർ ഡോക്യുമെന്റേഷൻ സൂക്ഷിക്കാൻ അനുവദിക്കുന്നു പൂർണ്ണമായും വേർതിരിക്കുകയും
അസംബ്ലി സൃഷ്ടിക്കാൻ ഉപയോഗിക്കുന്ന സോഴ്സ് കോഡിൽ നിന്ന് വ്യത്യസ്തമാണ്.

തിരിക്കാൻ മോണോഡോസർ മോണോയ്ക്ക് ഉപയോഗിക്കാനാകുന്ന ഒന്നിലേക്ക് ഡോക്യുമെന്റേഷൻ
ഡോക്യുമെന്റേഷൻ ബ്രൗസർ (ഡെസ്‌ക്‌ടോപ്പ് സഹായ ബ്രൗസർ അല്ലെങ്കിൽ അതിനുള്ള വെബ് ഇന്റർഫേസ്) ഇതാണ്
ഒരു പാക്ക് ഫോർമാറ്റിലേക്ക് ഡോക്യുമെന്റേഷൻ കംപൈൽ ചെയ്യേണ്ടത് ആവശ്യമാണ്. ഉപയോഗിച്ചാണ് ഇത് ചെയ്യുന്നത്
mdassembler ടൂൾ, ഉദാഹരണത്തിന്, നിങ്ങൾക്ക് ഈ ടൂൾചെയിൻ ഇതുപോലെ ഉപയോഗിക്കാം:

$ monodocer -അസംബ്ലി:MyWidgets -path:generated_docs
$ mdassembler --ecma generated_docs -out:MyWidgets

മുകളിൽ പറഞ്ഞവ ഒരു MyWidgets.zip ഉം MyWidgets.tree ഉം സൃഷ്ടിക്കും, അത് പിന്നീട് ഇൻസ്റ്റാൾ ചെയ്യാൻ കഴിയും.
സിസ്റ്റത്തിൽ. രണ്ട് ഫയലുകൾക്ക് പുറമേ (.zip, .tree) നിങ്ങൾ ഒരു .sources നൽകണം
സഹായ സിസ്റ്റത്തിൽ ഡോക്യുമെന്റേഷൻ എവിടെ ഹുക്ക് അപ്പ് ചെയ്യണമെന്ന് വിവരിക്കുന്ന ഫയൽ
വളരെ ലളിതമായ ഒരു XML ഫയൽ, ഇതുപോലെ:






ഡോക്യുമെന്റേഷൻ ECMA ഫോർമാറ്റിലാണെന്ന് മുകളിലുള്ള കോൺഫിഗറേഷൻ ഫയൽ വിവരിക്കുന്നു (The
സമാഹരിച്ച പതിപ്പ്) അടിസ്ഥാന ഫയലിന്റെ പേര് MyWidgets ആണെന്നും അത് ഹുക്ക് അപ്പ് ചെയ്യണമെന്നും
മരത്തിന്റെ "ക്ലാസ്ലിബ്-ഗ്നോം" ഭാഗം. നിർവചിച്ചിരിക്കുന്ന വിവിധ നോഡുകൾ നോക്കണമെങ്കിൽ
ഡോക്യുമെന്റേഷനിൽ, നിങ്ങൾക്ക് സാധാരണയായി ഇൻസ്റ്റാൾ ചെയ്തിട്ടുള്ള monodoc.xml ഫയൽ നോക്കാം
/usr/lib/monodoc/monodoc.xml.

നിങ്ങളുടെ എല്ലാ ഫയലുകളും (.zip, .tree, .sources) ലഭിച്ചുകഴിഞ്ഞാൽ നിങ്ങൾക്ക് അവ ഇൻസ്‌റ്റാൾ ചെയ്യാം
താഴെ പറയുന്ന കമാൻഡ് ഉള്ള സിസ്റ്റം:

$ cp MyWidgets.tree MyWidgets.zip MyWidgets.source `pkg-config monodoc --variable sourcesdir`

മുകളിലുള്ളവ മോണോഡോക്ക് രജിസ്റ്റർ ചെയ്ത ഡയറക്ടറിയിലേക്ക് ഫയലുകൾ പകർത്തും (നിങ്ങൾക്ക്
ഇത് ചെയ്യുന്നതിന് റൂട്ട് അനുമതികൾ ആവശ്യമാണ്). യഥാർത്ഥ ഡയറക്ടറി തിരികെ നൽകുന്നത് pkg-config
അഭ്യർത്ഥന.

സ്ട്രിംഗ് ID ഫോർമാറ്റ്

ഒരു തരത്തെയോ ഒരു തരത്തിലെ അംഗത്തെയോ സൂചിപ്പിക്കാൻ സ്ട്രിംഗ് ഐഡികൾ ഉപയോഗിക്കുന്നു. സ്ട്രിംഗ് ഐഡികൾ ഡോക്യുമെന്റ് ചെയ്തിരിക്കുന്നു
ECMA-334 മൂന്നാം പതിപ്പ്, അനെക്സ് E.3. അവയിൽ എ അംഗം ടൈപ്പ് ചെയ്യുക പ്രിഫിക്‌സ് , മുഴുവൻ തരം
പേര് (നെയിംസ്പേസ് + പേര്, '.' കൊണ്ട് വേർതിരിച്ചിരിക്കുന്നു), ഒരുപക്ഷേ അംഗത്തിന്റെ പേരും മറ്റുള്ളവയും
വിവരങ്ങൾ.

അംഗങ്ങളുടെ തരം പ്രിഫിക്സുകൾ:

E: സ്ട്രിംഗ് ഐഡി ഒരു ഇവന്റിനെ സൂചിപ്പിക്കുന്നു. ഇവന്റിന്റെ പേര് ടൈപ്പ് നെയിം പിന്തുടരുന്നു:
ഇ:System.AppDomain.AssemblyLoad

F: സ്ട്രിംഗ് ഐഡി ഒരു ഫീൽഡിനെ സൂചിപ്പിക്കുന്നു. ഫീൽഡ് നാമം തരം നാമത്തെ പിന്തുടരുന്നു:
F:System.Runtime.InteropServices.DllImportAttribute.SetLastError

M: ഒരു കൺസ്ട്രക്റ്ററെയോ രീതിയെയോ സൂചിപ്പിക്കുന്നു. നിർമ്മാതാക്കൾ കൂട്ടിച്ചേർക്കുന്നു .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: ഒരു നെയിംസ്പേസിനെ സൂചിപ്പിക്കുന്നു, ഉദാ N:സിസ്റ്റം

P: ഒരു വസ്തുവിനെ സൂചിപ്പിക്കുന്നു. പ്രോപ്പർട്ടി ഒരു സൂചിക ആണെങ്കിൽ അല്ലെങ്കിൽ പാരാമീറ്ററുകൾ എടുക്കുകയാണെങ്കിൽ, the
പാരാമീറ്റർ തരങ്ങൾ പ്രോപ്പർട്ടി നാമത്തിൽ കൂട്ടിച്ചേർക്കുകയും പരാന്തീസിസിനൊപ്പം ഉൾപ്പെടുത്തുകയും ചെയ്യുന്നു:
പി:സിസ്റ്റം.സ്ട്രിംഗ്.നീളം , P:System.String.Chars(System.Int32) .

T: സ്ട്രിംഗ് ഐഡി ഒരു തരത്തെ സൂചിപ്പിക്കുന്നു, പൊതുവായ തരങ്ങളുടെ എണ്ണം ചേർത്തിരിക്കുന്നു:
ടി:സിസ്റ്റം.സ്ട്രിംഗ് , T:System.Collections.Generic.List`1

കാര്യങ്ങൾ കൂടുതൽ രസകരമാക്കാൻ, പൊതുവായ തരങ്ങൾക്കും അംഗങ്ങൾക്കും രണ്ട് പ്രാതിനിധ്യങ്ങൾ ഉണ്ട്:
"അൺബൗണ്ട്" പ്രാതിനിധ്യം (മുകളിലുള്ള ഉദാഹരണങ്ങളിൽ കാണിച്ചിരിക്കുന്നു), ഇതിൽ ക്ലാസ് പേരുകൾക്ക് എണ്ണം ഉണ്ട്
അവരുടെ പേരിനൊപ്പം പൊതുവായ പാരാമീറ്ററുകൾ ചേർത്തു. ഒരു "ബൌണ്ട്" പ്രാതിനിധ്യവും ഉണ്ട്
ജനറിക് പാരാമീറ്ററുകളുടെ ബൈൻഡിംഗ് '{', '}' എന്നിവയ്ക്കുള്ളിൽ ലിസ്റ്റ് ചെയ്തിരിക്കുന്നു.

അൺബൗണ്ട്: 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}}}
.

നിങ്ങൾക്ക് കാണാനാകുന്നതുപോലെ, ബൗണ്ട് വേരിയന്റുകൾ ഏകപക്ഷീയമായി സങ്കീർണ്ണമാകാം (ജനറിക്‌സ് പോലെ).

കൂടാതെ, ഒരു ജനറിക് പാരാമീറ്റർ ഒരു തരത്തിന്റെയോ രീതിയുടെയോ ജനറിക് പാരാമീറ്ററുമായി ബന്ധിപ്പിച്ചിട്ടുണ്ടെങ്കിൽ,
തരം/രീതിയുടെ ജനറിക് പാരാമീറ്ററിന്റെ "സൂചിക" ബൈൻഡിംഗായി ഉപയോഗിക്കുന്നു, അങ്ങനെ നൽകിയിരിക്കുന്നു
ക്ലാസ് ഫൂടൈപ്പ് {
പൊതു സ്റ്റാറ്റിക് ശൂന്യമായ ഫൂ (സിസ്റ്റം. പ്രെഡിക്കേറ്റ് പ്രവചിക്കുക) {}
}
ഈ രീതിയുടെ സ്ട്രിംഗ് ഐഡി M:FooType.Foo``1(സിസ്റ്റം.പ്രെഡിക്കേറ്റ്{``0}) , as ``0 ആകുന്നു
0-ആം ജനറിക് പാരാമീറ്റർ ഇൻഡക്‌സ് ബന്ധിപ്പിച്ചിരിക്കുന്നു സിസ്റ്റം.പ്രെഡിക്കേറ്റ് .

പ്രമാണീകരണം ഫോർമാറ്റ്

മോണോഡോസർ വിവരിച്ചതുപോലെ, Ecma ഡോക്യുമെന്റേഷൻ ഫോർമാറ്റിന് സമാനമായ ഡോക്യുമെന്റേഷൻ സൃഷ്ടിക്കുന്നു
ECMA-335 മൂന്നാം പതിപ്പിൽ, പാർട്ടീഷൻ IV, അധ്യായം 3.

ECMA ഫോർമാറ്റിൽ നിന്നുള്ള പ്രധാന വ്യത്യാസം, ഓരോ തരത്തിനും അതിന്റേതായ ഫയൽ ലഭിക്കുന്നു എന്നതാണ്
ടൈപ്പിന്റെ നെയിംസ്‌പെയ്‌സിന് സമാനമായ ഒരു ഡയറക്‌ടറി.

ഡോക്യുമെന്റേഷനിലെ മിക്ക വിവരങ്ങളും ഉണ്ടായിരിക്കണം അല്ല എഡിറ്റ് ചെയ്യണം. ഇതിൽ ഉൾപ്പെടുന്നു
പേര് തരം ( /ടൈപ്പ്/@പൂർണ്ണനാമം ), നടപ്പിലാക്കിയ ഇന്റർഫേസുകൾ ( /തരം/ഇന്റർഫേസുകൾ ), അംഗം
വിവരങ്ങൾ ( /തരം/അംഗങ്ങൾ/അംഗം/@അംഗനാമം , /തരം/അംഗങ്ങൾ/അംഗങ്ങൾ/അംഗങ്ങൾ ഒപ്പ് ,
/തരം/അംഗങ്ങൾ/അംഗം/അംഗ തരം , /തരം/അംഗങ്ങൾ/അംഗങ്ങൾ/പാരാമീറ്ററുകൾ , തുടങ്ങിയവ.).

എന്ത് വേണം പരിഷ്‌ക്കരിക്കപ്പെടുക എന്നത് ടെക്‌സ്‌റ്റിനൊപ്പമുള്ള എല്ലാ ഘടകങ്ങളും ആണ് ലേക്ക് be ചേർത്തു. , നിലവിലുള്ളത്
കീഴെ //ഡോക്സ് ഘടകങ്ങൾ (ഉദാ /തരം/ഡോക്സ് , /തരം/അംഗങ്ങൾ/അംഗങ്ങൾ/ഡോക്‌സ് ). ഉള്ളടക്കം
എന്ന ഡോക്സ് ഘടകം ആണ് സമാനമായ ഇൻലൈൻ സി# ഡോക്യുമെന്റേഷനിലേക്കുള്ള സെമാന്റിക്സിലും ഘടനയിലും
ഈ ഘടകങ്ങൾ അടങ്ങുന്ന ഫോർമാറ്റ് (ECMA-334 മൂന്നാം പതിപ്പിൽ, അനെക്സ് ഇ, സെക്ഷൻ 3 ൽ പട്ടികപ്പെടുത്തിയിരിക്കുന്നു).
മൂലക വിവരണങ്ങളിൽ ഇനിപ്പറയുന്നവ ഉപയോഗിക്കുന്നു:

സി.ആർ.ഇ.എഫ് ഒരു ക്ലാസ് (അല്ലെങ്കിൽ അംഗം) റഫറൻസിനെ സൂചിപ്പിക്കുന്നു, ഇത് വിവരിച്ച ഫോർമാറ്റിലുള്ള ഒരു സ്ട്രിംഗാണ്
മുകളിൽ സ്ട്രിംഗ് ID ഫോർമാറ്റ് വിഭാഗം.

TEXT നോൺ-എക്സ്എംഎൽ ടെക്സ്റ്റ്, എക്സ്എംഎൽ എന്നിവ നെസ്റ്റ് ചെയ്യാൻ പാടില്ല.

എക്സ്എംഎൽ XML ഘടകങ്ങൾ മാത്രം നെസ്റ്റഡ് ചെയ്യണം (അതിൽ പരോക്ഷമായി ടെക്‌സ്‌റ്റ് അടങ്ങിയിരിക്കാം), എന്നാൽ അല്ലാത്തവ
വൈറ്റ്‌സ്‌പേസ് ടെക്‌സ്‌റ്റ് ഉടനടി ചൈൽഡ് നോഡ് ആകരുത്.

XML_TEXT
സ്വതന്ത്ര-ഫോം ടെക്‌സ്‌റ്റും XML-ഉം, അതുവഴി മറ്റ് XML ഘടകങ്ങൾ നെസ്റ്റഡ് ചെയ്യാം.

ഡോക്യുമെന്റേഷനിൽ ഇനിപ്പറയുന്ന ഘടകങ്ങൾ ഉപയോഗിക്കുന്നു:

<തടയുക ഉപഗണം="സബ്സെറ്റ്" type="TYPE">XML_TEXT
ഒരു ഖണ്ഡികയുടെ ആശയത്തിന് സമാനമായ ഒരു ടെക്‌സ്‌റ്റ് സൃഷ്‌ടിക്കുക, പക്ഷേ സൃഷ്‌ടിക്കുന്നതിന് ഉപയോഗിക്കുന്നു
വാചകത്തിനുള്ളിലെ വിഭജനം. ഒരു പരിധി വരെ, എ HTML ന് തുല്യമാണ്
ടാഗ്.

ഉപഗണം എല്ലായ്പ്പോഴും മൂല്യമായിരിക്കണം ആരും .

തരം ഉപയോഗിക്കേണ്ട തലക്കെട്ടും ഫോർമാറ്റിംഗും വ്യക്തമാക്കുന്നു. അംഗീകൃത തരങ്ങൾ ഇവയാണ്:

സ്വഭാവങ്ങൾ തലക്കെട്ടുള്ള ഒരു വിഭാഗം സൃഷ്ടിക്കുന്നു ഓപ്പറേഷൻ .

കുറിപ്പ് തലക്കെട്ടുള്ള ഒരു വിഭാഗം സൃഷ്ടിക്കുന്നു കുറിപ്പ്: .

അസാധുവാക്കുന്നു തലക്കെട്ടുള്ള ഒരു വിഭാഗം സൃഷ്ടിക്കുന്നു കുറിപ്പ് ലേക്ക് അവകാശികൾ .

ഉപയോഗം തലക്കെട്ടുള്ള ഒരു വിഭാഗം സൃഷ്ടിക്കുന്നു ഉപയോഗം .

XML_TEXT
ഒരു കോഡ് പോലുള്ള ഫോണ്ടിൽ ടെക്സ്റ്റ് സജ്ജീകരിക്കുക (HTML എലമെന്റിന് സമാനമായത് ).

<കോഡ് lang="LANGUAGE">വാചകം
കോഡ് പോലുള്ള ഫോണ്ടിൽ ഒന്നിലധികം വരികൾ പ്രദർശിപ്പിക്കുക (HTML-ന് സമാനമായത്
ഘടകം). LANGUAGE എന്ന ഈ കോഡ് ബ്ലോക്ക് ഉള്ള ഭാഷയാണ്. ഉദാഹരണത്തിന്, എങ്കിൽ
LANGUAGE എന്ന is C# എന്നിട്ട് TEXT ഉള്ളിലുള്ള C# ഭാഷയ്‌ക്കായി സിന്റാക്സ് ഹൈലൈറ്റിംഗ് ലഭിക്കും
മോണോ ഡോക്യുമെന്റേഷൻ ബ്രൗസർ.

XML_TEXT
പ്രത്യേകമായി പ്രദർശിപ്പിക്കേണ്ട ഒരു ഉദാഹരണം സൂചിപ്പിക്കുന്നു. ഉദാഹരണത്തിന്:

ഒരു ആമുഖ ഖണ്ഡിക.

ക്ലാസ് ഉദാഹരണം {
പൊതു സ്റ്റാറ്റിക് ശൂന്യമായ മെയിൻ ()
{
System.Console.WriteLine ("ഹലോ, വേൾഡ്!");
}
}



<അപവാദം cref="CREF">XML_TEXT
ഡോക്യുമെന്റഡ് അംഗത്തിന് എറിയാൻ കഴിയുന്ന ഒരു ഒഴിവാക്കൽ തിരിച്ചറിയുന്നു.

ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

സി.ആർ.ഇ.എഫ് എറിയപ്പെടുന്ന ഒഴിവാക്കൽ തരമാണ്, അതേസമയം XML_TEXT അടങ്ങിയിരിക്കുന്നു
കാരണമാകും സാഹചര്യങ്ങൾ സി.ആർ.ഇ.എഫ് എറിയണം.

ആയിരുന്നു .


എക്സ്എംഎൽ
ഇനങ്ങളുടെ ഒരു പട്ടിക അല്ലെങ്കിൽ പട്ടിക സൃഷ്ടിക്കുക. നെസ്റ്റഡ് ഉപയോഗപ്പെടുത്തുന്നു എക്സ്എംഎൽ ,
എക്സ്എംഎൽ , XML_TEXT , ഒപ്പം
XML_TEXT ഘടകങ്ങൾ.

ലിസ്റ്റുകൾ വാക്യഘടന ഉണ്ടായിരിക്കുക:

ബുള്ളറ്റ് 1
ബുള്ളറ്റ് 2
ബുള്ളറ്റ് 3


പട്ടികകൾ വാക്യഘടന ഉണ്ടായിരിക്കുക:


കോളം 1
കോളം 2
കോളം 3


ഇനം 1-എ
ഇനം 1-ബി
ഇനം 1-സി


ഇനം 2-എ
ഇനം 2-ബി
ഇനം 2-സി



XML_TEXT
എന്നതിന്റെ ഒരു ഖണ്ഡിക ചേർക്കുക XML_TEXT
. ഇത് മറ്റ് ടാഗുകൾക്കുള്ളിൽ ഉപയോഗിക്കാനുള്ളതാണ് , ,
, ഒപ്പം (കാണുക , മുകളിൽ), കൂടാതെ മറ്റ് മിക്ക ഘടകങ്ങളും.

ഉദാഹരണത്തിന്,
ഇത് വാചകത്തിന്റെ ഒരു ഖണ്ഡികയാണ്.

<പരം name="NAME">XML_TEXT
ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

പരാമീറ്റർ വിവരിക്കുന്നു NAME നിലവിലെ കൺസ്ട്രക്റ്റർ, രീതി അല്ലെങ്കിൽ സ്വത്ത്:

എ നമ്പർ ഉൾക്കൊള്ളുന്നു
പ്രോസസ്സ് ചെയ്യാനുള്ള വിജറ്റുകളുടെ.


<പാരാമെഫ് പേര്="NAME" />
എന്ന് സൂചിപ്പിക്കുന്നു NAME ഒരു പാരാമീറ്ററാണ്.

ഇത് സാധാരണയായി റെൻഡർ ചെയ്യുന്നു NAME ഇറ്റാലിക് ടെക്‌സ്‌റ്റായി, അതിനാൽ ഇത് പതിവായി (ab)ഒരു ആയി ഉപയോഗിക്കുന്നു
HTML ഘടകത്തിന് തുല്യമാണ് . കാണുക ഡോക്യുമെന്റേഷൻ (മുകളിൽ)
ഉദാഹരണത്തിന്.

<അനുമതി cref="CREF">XML_TEXT
നിലവിലെ അംഗത്തിന്റെ സുരക്ഷാ പ്രവേശനക്ഷമത ആവശ്യകതകൾ രേഖപ്പെടുത്തുന്നു.

ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

സി.ആർ.ഇ.എഫ് ആവശ്യമായ സുരക്ഷാ അനുമതിയുടെ ഒരു തരം റഫറൻസ് ആണ്, അതേസമയം XML_TEXT ഒരു ആണ്
എന്തുകൊണ്ട് അനുമതി ആവശ്യമാണ് എന്നതിന്റെ വിവരണം.

ഫയലുകൾ വായിക്കുന്നതിനും എഴുതുന്നതിനും അനുമതി ആവശ്യമാണ്. കാണുക
,
.


XML_TEXT
ഒരു അംഗത്തെക്കുറിച്ചുള്ള വിശദമായ വിവരങ്ങൾ അടങ്ങിയിരിക്കുന്നു.

ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.
വിശദമായ വിവരങ്ങൾ ഇവിടെ ചേർക്കുക.

XML_TEXT

ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

ഒരു രീതിയുടെ റിട്ടേൺ മൂല്യം വിവരിക്കുന്നു:

എ എന്ന് വ്യക്തമാക്കുന്നു
അല്ലെങ്കിൽ പ്രക്രിയയ്ക്ക് ആക്സസ് ചെയ്യാൻ കഴിയില്ല
.


<കാണുക cref="CREF" />
നിലവിലെ വാചകത്തിനുള്ളിൽ വ്യക്തമാക്കിയ അംഗത്തിലേക്കുള്ള ഒരു ലിങ്ക് സൃഷ്ടിക്കുന്നു:


<ഇതും കാണുക cref="CREF" />

ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

ഇതിനായി ഒരു എൻട്രി സൃഷ്ടിക്കാൻ അനുവദിക്കുന്നു കാണുക എതിരെ ഉപവകുപ്പ്. ഉപയോഗിക്കുക വ്യക്തമാക്കാൻ
ടെക്സ്റ്റിനുള്ളിൽ നിന്നുള്ള ഒരു ലിങ്ക്.


<മുതൽ പതിപ്പ്="VERSION" />

ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

നിർദ്ദിഷ്‌ട തരം അല്ലെങ്കിൽ അംഗം ഏത് പതിപ്പാണ് അവതരിപ്പിച്ചത് എന്നതിന്റെ പെർമിറ്റ്.


വിവരണം

ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

ഒരു തരം അല്ലെങ്കിൽ തരം അംഗത്തെക്കുറിച്ചുള്ള ഒരു (ചുരുക്കമുള്ള!) അവലോകനം നൽകുന്നു.

ഇത് സാധാരണയായി ഒരു ക്ലാസ് ഡിക്ലറേഷന്റെ ഭാഗമായി പ്രദർശിപ്പിക്കും, കൂടാതെ a ആയിരിക്കണം
തരം/അംഗത്തിന്റെ ന്യായമായ ഹ്രസ്വ വിവരണം. ഉപയോഗിക്കുക കൂടുതൽ വിശദമായി
വിവരങ്ങൾ.

<തരം name="NAME">DESCRPITION
ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

ഒരു ജനറിക് തരത്തിനോ ജനറിക് രീതിക്കോ വേണ്ടിയുള്ള തരം പാരാമീറ്റർ വിവരിക്കാൻ ഇത് ഉപയോഗിക്കുന്നു.

NAME ടൈപ്പ് പാരാമീറ്ററിന്റെ പേരാണ്, while വിവരണം എന്നതിന്റെ ഒരു വിവരണം അടങ്ങിയിരിക്കുന്നു
പരാമീറ്റർ (അത് എന്തിനുവേണ്ടിയാണ് ഉപയോഗിക്കുന്നത്, എന്ത് നിയന്ത്രണങ്ങൾ പാലിക്കണം, മുതലായവ).
അടിസ്ഥാന ശേഖരത്തിന്റെ തരം


ഒരു വാക്ക് ഒരു തരം പാരാമീറ്ററാണെന്ന് സൂചിപ്പിക്കാൻ ഉപയോഗിക്കുന്നു, മറ്റ് ടെക്സ്റ്റ് ബ്ലോക്കുകളിൽ ഉപയോഗിക്കുന്നതിന്
(ഉദാ. ഉള്ളിൽ ).
എങ്കിൽ ഒരു struct ആണ്, അപ്പോൾ...

വിവരണം
ഒരു ഉയർന്ന തലത്തിലുള്ള മൂലകമാണ്, നേരിട്ട് നെസ്റ്റ് ചെയ്യണം
ഘടകം.

ഒരു പ്രോപ്പർട്ടി വിവരിക്കാൻ അനുവദിക്കുന്നു.

എ ഒരു വിജറ്റ് നാമം അടങ്ങിയിരിക്കുന്നു.

onworks.net സേവനങ്ങൾ ഉപയോഗിച്ച് മോണോഡോസർ ഓൺലൈനായി ഉപയോഗിക്കുക