Beschreibung für DependencyProperties

Hallo!

Wie kann ich denn für eine DP eine Beschreibung für den Benutzer "definieren"?

Also adäquat der Summary-Angabe bei VM-Eigenschaften.

private static readonly DependencyProperty RahmenAbstandProperty =
DependencyProperty.Register("RahmenAbstand", typeof(Thickness), typeof(UCMediaElement),
                      new PropertyMetadata(new Thickness(2)));

/// <summary>
/// Der Rahmenabstand ist der Abstand zwischen Rahmen und Inhalt
/// </summary>

Sorry hat sich glaube erledigt.

Bei der public-Variablen zur DP scheint es zu funktionieren.

        private static readonly DependencyProperty RahmenAbstandProperty =
            DependencyProperty.Register("RahmenAbstand", typeof(Thickness), typeof(UCMediaElement),
                                        new PropertyMetadata(new Thickness(2)));
        /// <summary>
        /// (Innerer) Abstand zwischen dem Rahmen und dem Inhalt.
        /// </summary>
        public Thickness RahmenAbstand
        {
            get => (Thickness)GetValue(RahmenAbstandProperty);
            set => SetValue(RahmenAbstandProperty, value);
        }

Muss nur noch kontrollieren, ob es auch bei der Weitergabe des UserControls noch angezeigt wird.

Hallo!

Ich muss mich noch einmal korrigieren.

Die Beschreibung einer DP wird mir bei der Instanzierung des UC's (in XAML) nicht angezeigt. Die DP's erscheinen (im Eigenschafts-Fenster) bei Sonstiges. Aber auch da, ohne die/eine Beschreibung.

Hast du denn auch die XML Dokumentationsdatei erzeugt (bzw. weitergegeben, d.h. neben der Assembly-DLL)?

Guten Morgen Th69!

Um mit Sokrates zu sprechen: Ich weiß, dass ich nichts weiß.

Diese Option (XML-Dokumentationsdatei) in den Projekt Build-Optionen ist mir noch nie aufgefallen.

Jetzt habe ich 498 Warnungen ... denn das wird ja auch konsequent durchgezogen (jede öffentliche Eigenschaft oder Type muss dann eine Beschreibung haben) aber es funktioniert! (Das ich diese auch unterdrücken könnte ist mir schon bewusst.)

Interessant ist allerdings, dass dadurch auch vergessene Beschreibungen von Parametern bei Methoden offensichtlich werden.

Warnung	CS1573	Der x/y-Parameter hat (im Gegensatz zu anderen Parametern) kein entsprechendes param-Tag im ...

Vielen Dank für deine Hilfe!

PS:  Hier gibt es dann gleich noch viel mehr ...

Zitat von perlfred

... denn das wird ja auch konsequent durchgezogen (jede öffentliche Eigenschaft oder Type muss dann eine Beschreibung haben) aber es funktioniert! (Das ich diese auch unterdrücken könnte ist mir schon bewusst.)

Vorweg: konsequent ist nicht immer sinnvoll.

Das Gute ist: durch Copilot (vor allem das derzeitige Copilot X) lassen sich solche Docs sehr gut generieren, auch qualitativ in Ordnung.
Man muss sowas nicht zur ABM kommen lassen.

Hallo Abt!

Vor lauter Neuem (Copilot) komme ich ja gar nicht mehr zum Programmieren! 😃

Für Bibliotheken werde ich die XML-Dokumentationsdatei schon erstellen, aber für App's wird es schnell zu aufwendig! Hat aber trotzdem Etwas.

Danke für deinen Hinweis!