A parancsmag leírásának hozzáadása
Ez a szakasz azt ismerteti, hogyan adhat hozzá olyan tartalmakat, amelyek a parancsmag súgója DESCRIPTION (LEÍRÁS) szakaszában jelennek meg. A súgófájlban ez a tartalom minden parancsmaghoz hozzáadódik a Parancs csomóponthoz.
Megjegyzés
A súgófájl teljes megtekintéséhez nyissa meg a PowerShell telepítési könyvtárában dll-Help.xml
található fájlok valamelyikét. A fájl például több PowerShell-parancsmag tartalmát Microsoft.PowerShell.Commands.Management.dll-Help.xml
is tartalmazza.
Leírás hozzáadása
Először is ismertesse részletesebben a parancsmag alapvető funkcióit. Sok esetben egy példát is bemutathat a parancsmag nevében használt kifejezésekre, és szemléltetheti az ismeretlen fogalmakat. Ha például a parancsmag adatokat fűz egy fájlhoz, elmagyarázhatja, hogy egy meglévő fájl végéhez ad hozzá adatokat.
A parancsmag összes funkcióját a paraméterlistával találhatja meg. Írja le a parancsmag elsődleges funkcióját, majd más függvényeket és funkciókat is tartalmaz. Ha például a parancsmag fő funkciója egy tulajdonság módosítása, de a parancsmag az összes tulajdonságot módosíthatja, például a részletes leírásban. Ha a parancsmag paraméterei lehetővé teszi, hogy a felhasználók különböző módokon kérnek információkat, magyarázzák el.
A nyilvánvaló használati módok mellett a felhasználók által használható parancsmagokkal kapcsolatos információkat is tartalmaz. A parancsmag által lekért objektummal például módosíthatja a szöveg színét a Windows PowerShell
Get-Host
parancsablakban.Például: "A parancsmag olyan objektumokat kap, amelyek egy fájl vagy erőforrás biztonsági
Get-Acl
leíróját képviselik. A biztonsági leíró tartalmazza az erőforrás hozzáférés-vezérlési listáit (ACL-eket). Az ACL határozza meg azokat az engedélyeket, amelyekre a felhasználóknak és felhasználói csoportoknak az erőforráshoz való hozzáféréshez rendelkezniük kell."A részletes leírásnak le kell írnia a parancsmagot, de a parancsmag által használt fogalmakat nem. Helyezze el a fogalmak definícióit a További megjegyzések között.
Lásd még:
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: