Bir cmdlet yardım konusuna cmdlet adını ve özetini ekleme

Not

XML tabanlı yardımın manuel olarak yazılması çok zordur. PlatyPS modülü, Markdown'da yardım yazmanıza ve ardından bunu XML tabanlı yardıma dönüştürmenize olanak tanır. Bu, yardım yazmayı ve sürdürmeyi çok daha kolaylaştırır. PlatyPS ayrıca sizin için Güncellenebilir Yardım paketleri de oluşturabilir. Daha fazla bilgi için PlatyPS kullanarak XML tabanlı yardım oluşturma konusuna bakın.

Bu bölümde, cmdlet yardımının AD ve ÖZET bölümlerinde görüntülenen içeriğin nasıl ekleneceği açıklanmaktadır. Yardım dosyasında bu içerik, her cmdlet'in Komut düğümüne eklenir.

Not

Yardım dosyasının tam görünümü için PowerShell kurulum dizininde bulunan dll-Help.xml dosyalarından birini açın. Örneğin, Microsoft.PowerShell.Commands.Management.dll-Help.xml dosyası birçok PowerShell cmdlet'ine ilişkin içerik içerir.

Cmdlet adını ve özetini eklemek için

  • Cmdlet Yardımı, cmdlet için iki açıklama görüntüleyebilir. İlk açıklama, özet olarak adlandırılan kısa bir açıklamadır. İkinci açıklama, Ayrıntılı Açıklamayı Cmdlet Yardım Konusuna Ekleme bölümünde açıklanan daha ayrıntılı bir açıklamadır. Bu açıklamaların her ikisi de tek paragraf olarak yazılmalıdır.

  • Özette cmdlet adını tekrarlamayın. Kullanıcıyı Get-Server cmdlet'inin bir sunucu aldığı konusunda bilgilendirmek kısadır ancak bilgilendirici değildir. Bunun yerine eşanlamlıları kullanın ve açıklamaya ayrıntılar ekleyin.

    Örnek: "Yerel veya uzak bir bilgisayarı temsil eden bir nesne alır."

  • Özette "almak", "yaratmak" ve "değiştirmek" gibi basit fiiller kullanın. "Set" kelimesini kullanmaktan kaçının çünkü belirsizdir ve "değiştir" gibi süslü kelimelerdir.

    Örnek: "Bir dosyadaki Authenticode imzası hakkında bilgi alır."

  • Aktif sesle yazın. Örneğin, "TimeSpan nesnesini kullan..." ifadesi, "TimeSpan nesnesi şunun için kullanılabilir..." ifadesinden çok daha açıktır.

  • Nesneleri alan cmdlet'leri tanımlarken "ekran" fiilinden kaçının. Windows PowerShell cmdlet verilerini görüntülese de, kullanıcılara cmdlet'in verileri görüntülenemeyen .NET Framework nesnelerini döndürdüğü kavramını tanıtmak önemlidir. Görüntüyü vurgularsanız kullanıcı, cmdlet'in görüntülenmeyen birçok başka yararlı özellik ve yöntem döndürmüş olabileceğini fark etmeyebilir.

Ayrıca bakınız

Windows PowerShell SDK'sı

İlgili makaleler