Default-Beschreibungen abschalten

Default-Beschreibungen abschalten

Moin,

wenn ich einen Methodenparameter definiere, wird die Beschreibung des zugrundeliegenden Datentyps ins Beschreibungsfeld eingefügt. Gleiches bei Attributen in einer Klasse.

Kann man das abschalten?

Hintergrund: Die Beschreibungen sind meist viel zu allgemein und berücksichtigen nicht den Kontext. So erfahre ich, dass VBELN eine Vertriebsbelegnummer ist, aber nicht, dass es sich bei dieser Methode z. B. um die Nummer eines zu buchenden Auftrages handelt. Ebenso bei der Definition von Konstanten: Definiere ich z. B. drei Konstanten in den Attributen einer Klasse, alle auf Basis der Vertriebsbelegart, haben alle drei denselben Text - und keinen konstantenspezifischen. Der werte Leser darf dann raten, welchen Zweck die Konstante hat (Komstantennamen sind schon aufgrund der Längenbeschränkung oft nicht sprechend). Es hängt rein an der Disziplin jedes einzelnen Entwicklers, das im Beschreibungsfeld treffender zu beschreiben.

Das sieht schön und fertig aus, ich möchte aber, dass Beschreibungen kontextbezogen treffend sind. Schaltet man die Automatik ab, fällt ein nicht gefülltes Feld auf (man kann sogar den SCI darauf prüfen lassen) und ich kann es dem Codiersklaven um die Ohren hauen.

Darum würde ich sie gern abschalten. Geht das?


Ralf

Re: Default-Beschreibungen abschalten

ewx hat geschrieben:Ich wüsste nicht, dass das geht.
Aber evtl. andersherum: Wenn du sagst, dass es eine CI-Prüfung auf "leer" gibt, dann kopiere diese Prüfung doch und prüfe ab, ob der Text eines Typs in der Methode mit der aus dem DDIC übereinstimmt. Dann hättest du zumindest einen Anhaltspunkt.

Als Anmerkung noch: Es gibt auch die Datenelemente VBELN_VA, VBELN_VF etc, die die Art des Vertriebsbelegs spezifizieren...

1. Richtig, aber das müsste ich extra programmieren - ein Häkchen im Customizing wegzumachen, geht einfacher.

2. Ja, ich weiß das. Aber erzähl mal das einem Codiersklaven, der froh ist, dass er VBELN gefunden hat. Und solche Spezialisierungen gibt es auch nicht für jedes Datenelement. Und letztlich: So genau, wie ich es gern beschrieben hätte, ist es dann eben doch nicht. Jedes Bisschen Dokumentation hilft, eine Anwendung zu verstehen.


Ralf

Re: Default-Beschreibungen abschalten

ewx hat geschrieben:Bei bestimmten Dingen helfen einfach nur Schulung und regelmäßige Audits.
Und ganz ehrlich: wenn ein "Codierknecht" froh ist, ein einigermaßen passendes Datenelement gefunden zu haben, meinst du ernsthaft, dass derjenige sich dann Mühe gibt, genau zu beschreiben, um was es sich handelt? Du wirst dann eher Einträge bekommen wie "Beleg", "V.Dok." oder sogar "Hier muss was stehen" die dann eher kontraproduktiv sind.
Irgendwann muss man auch mal die Kirche im Dorf lassen.
Und solange ein Programmierer es selbst nicht wichtig findet, sprachlich genau zu sein (was im Übrigen die wenigsten sind...), kannst du es ihm auch nicht einprügeln oder mit Regeln zwingen.

Das ist das Problem, darum will ich, dass er SIEHT, was er noch nicht beschrieben hat. Oder ich ihm im SCI zeigen kann, was er noch nicht beschrieben hat. Dass er "Müll" reinschreibt, wenn er schon im Feld ist, glaube ich nicht. DAS wäre Insubordination


Ralf

Re: Default-Beschreibungen abschalten

black_adept hat geschrieben:

ralf.wenzel hat geschrieben:Das ist das Problem, darum will ich, dass er SIEHT, was er noch nicht beschrieben hat. Oder ich ihm im SCI zeigen kann, was er noch nicht beschrieben hat. Dass er "Müll" reinschreibt, wenn er schon im Feld ist, glaube ich nicht. DAS wäre Insubordination
Ralf

Die wahrscheinlichste Reaktion wird sein, dass der Codierknecht einen Doppelklick auf das Datenelement macht und sich dann die Beschreibung kopiert und dir als sinnvolle Doku anbietet und am Ende bist du wieder da wo du angefangen hast

Wem das lieber ist als drei Worte einzutippen, der wird in meinen Projekten nicht alt.


Ralf