Példák hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhöz
Példákkal kapcsolatos dolgok a parancsmagokkal kapcsolatos súgóban
Listába sorolja a parancs összes paraméternevét, még akkor is, ha a paraméternevek megadása nem kötelező. Ez segít a felhasználónak a parancs egyszerű értelmezésében.
Kerülje az aliasok és a részleges paraméternevek mellőzését, még akkor is, ha a PowerShellben működnek.
A példaleírásban ismertesse a parancs szerkezetének magyarázatát. Annak magyarázata, hogy miért adott paramétereket és értékeket választott, és hogyan használja a változókat.
Ha a parancs kifejezéseket használ, részletesen ismertesse őket.
Ha a parancs objektumtulajdonságokat és -metódusokat használ, különösen az alapértelmezett megjelenítésben nem megjelenő tulajdonságokat, használja a példát lehetőségként, amely tudatja a felhasználóval az objektumot.
Példákat megjelenítő súgónézetek
A példák csak a parancsmagok súgó részletes és teljes nézeteiben jelennek meg.
Példák csomópont hozzáadása
Az alábbi XML bemutatja, hogyan adhat hozzá egy Példák csomópontot, amely egyetlen Példa csomópontot tartalmaz. Adjon hozzá további példacsomópontokat a témakörbe felvenni kívánt példákhoz.
<command:examples>
<command:example>
</command:example>
</command:examples>
Példacím hozzáadása
Az alábbi XML bemutatja, hogyan adhat hozzá címet a példához. A cím a példát a többi példától eltekintve adja meg. A PowerShell egy szabványos fejlécet használ, amely szekvenciális példaszámot tartalmaz.
<command:examples>
<command:example>
<maml:title>---------- EXAMPLE 1 ----------</maml:title>
</command:example>
</command:examples>
Megelőző karakterek hozzáadása
Az alábbi XML bemutatja, hogyan adhat hozzá karaktereket, például a Windows PowerShell parancssort, amelyek közvetlenül a példaparancs előtt jelennek meg (szóközök nélkül). A PowerShell a következő Windows PowerShell parancssort használja: C:\PS>
.
<command:examples>
<command:example>
<maml:title>---------- EXAMPLE 1 ----------</maml:title>
<maml:Introduction>
<maml:paragraph>C:\PS></maml:paragraph>
</maml:Introduction>
</command:example>
</command:examples>
A parancs hozzáadása
Az alábbi XML bemutatja, hogyan adhatja hozzá a példa tényleges parancsát. A parancs hozzáadásakor írja be a parancsmagok és paraméterek teljes nevét (ne használjon aliast). Amikor csak lehetséges, használjon kisbetűket.
<command:examples>
<command:example>
<maml:title>---------- EXAMPLE 1 ----------</maml:title>
<maml:Introduction>
<maml:paragraph>C:\PS></maml:paragraph>
</maml:Introduction>
<dev:code> command </dev:code>
</command:example>
</command:examples>
Leírás hozzáadása
Az alábbi XML bemutatja, hogyan adhat hozzá leírást a példához. A PowerShell egyetlen címkekészletet használ a <maml:para>
leíráshoz, annak ellenére, hogy több <maml:para>
címke is használható.
<command:examples>
<command:example>
<maml:title>---------- EXAMPLE 1 ----------</maml:title>
<maml:Introduction>
<maml:paragraph>C:\PS></maml:paragraph>
</maml:Introduction>
<dev:code> command </dev:code>
<dev:remarks>
<maml:para> command description </maml:para>
</dev:remarks>
</command:example>
</command:examples>
Példakimenet hozzáadása
Az alábbi XML bemutatja, hogyan adjuk hozzá a parancs kimenetét. A parancseredmények információi nem kötelezőek, de bizonyos esetekben hasznos lehet bemutatni bizonyos paraméterek használatának hatását.
A PowerShell két üres címkével választja el a parancs <maml:para>
kimenetét a parancstól.
<command:examples>
<command:example>
<maml:title>---------- EXAMPLE 1 ----------</maml:title>
<maml:Introduction>
<maml:paragraph>C:\PS></maml:paragraph>
</maml:Introduction>
<dev:code> command </dev:code>
<dev:remarks>
<maml:para> command description </maml:para>
<maml:para></maml:para>
<maml:para></maml:para>
<maml:para> command output </maml:para>
</dev:remarks>
</command:example>
</command:examples>
Visszajelzés
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Visszajelzés küldése és megtekintése a következőhöz: