Sie haben eine HotDocs-Entwicklerlizenz erworben, sich die Tutorials angesehen und vielleicht sogar eine Entwicklerschulung erhalten. Vielleicht sind Sie sogar so weit gegangen, dass Sie die HotDocs-Hilfedatei gelesen oder das HotDocs-Wiki durchstöbert haben. In jedem Fall sind Sie bereit, mit der Entwicklung von HotDocs-Prozessanwendungen für Ihre Kanzlei oder Ihr Unternehmen zu beginnen.
Sie haben gelernt, dass sich die Kernfunktionalität von HotDocs um die Komponenten oder Variablen dreht, die Sie erstellen. (Eine Komponente ist alles, was Sie in der Komponentendatei erstellen und das mit Ihrer Dokumentvorlage verbunden ist [z. B. Dialoge, Variablen usw.]). Vielleicht ist Ihnen schon aufgefallen, dass die Namenskonventionen, die Sie für Ihre Komponenten verwenden, entscheidend für die langfristige Funktionalität und Einsatzfähigkeit Ihrer HotDocs Process-Anwendungen sind. Im Folgenden finden Sie drei Benennungsregeln, die Ihnen bei der Entwicklung von HotDocs helfen werden.
Verbotene Zeichen und ein verbannter CASE
Komponentennamen sollten relativ kurz, aber aussagekräftig sein. Ein Komponentenname kann bis zu 50 Zeichen enthalten, darunter Buchstaben, Zahlen und einige Symbole. Das erste Zeichen muss jedoch ein Buchstabe sein. Jeder Komponentenname muss eindeutig sein - auch wenn es sich um verschiedene Komponententypen handelt, dürfen ihre Namen nicht identisch sein.
Die folgenden Zeichen dürfen nur verwendet werden, wenn unmittelbar davor oder danach ein anderes Zeichen als ein Leerzeichen steht; von der Verwendung dieser Zeichen wird jedoch dringend abgeratenin Anbetracht möglicher zukünftiger Änderungen an HotDocs:
Sie können nicht Die folgenden Zeichen können Sie bei der Benennung Ihrer Komponenten nicht verwenden:
Da HotDocs UPPERCASE für seine Anweisungs- und Ausdrucksmodelle verwendet, ist es am besten, wenn NICHT Großbuchstaben zu verwenden, wenn Sie Ihre Komponenten benennen. Sie können zum Beispiel eine Komponente nicht "ADD ATTY TO MC" nennen, da "ADD" in HotDocs ein reserviertes Befehlswort ist. Selbst wenn Sie in Ihren Komponentennamen Wörter in Großbuchstaben schreiben, bei denen es sich nicht um Anweisungs- oder Ausdrucksmodelle handelt, können Sie nie sicher sein, ob HotDocs das von Ihnen in Großbuchstaben geschriebene Wort in die Liste der reservierten Wörter aufnimmt oder nicht. Es ist also besser, "CamelCase", "Sentence case" oder "lowercase" zu verwenden, als "UPPERCASE" und "sorry".
Gattung > Art/Allgemeines > Spezifisches
Eine Praxis, die dabei hilft, Komponenten im Komponentenmanager zu organisieren und generell die wie Dinge mit wie zu halten, ist es, Ihre Komponenten mit Wörtern zu benennen, die allgemein beginnen und dann spezifischer werden. Der Wortstamm des Komponentennamens könnte zum Beispiel ein Primärschlüsselwort für eine Gruppe oder ein Thema sein (z.B., KundeName). Dieses Schlüsselwort ist oft das erste Wort des Komponentennamens, aber je nach Komponententyp kann es auch anders lauten. Nachfolgende Wörter im Variablennamen sollten zunehmend spezifischer sein und zunächst eine sekundäre Gruppe beschreiben, falls erforderlich, und dann spezifischere Aspekte (z. B. ClientRealPropertyLegalDescription). Generell ist es empfehlenswert, Artikel und Präpositionen so weit wie möglich zu vermeiden. Wenn Sie die Wahl zwischen "NameOfClient" und "ClientName" haben, verwenden Sie Letzteres.
Beispiele
Spare in der Zeit 50 Zeichen, so hast du in der Not
An dieser Stelle riskiere ich, einen Flame War auszulösen. (Für diejenigen, die mit dem Begriff nicht vertraut sind: Ein Flame War entzündet sich in Internet-Entwicklungsforen, wenn sich Befürworter gegensätzlicher und tief verwurzelter Überzeugungen über "ihren Weg" der Programmierung in einem Thread gegenseitig verunglimpfen [z.B. Microsoft vs. Apple-Produkte].) Was ich hier vorschlage, mag für Entwickler, die bereits viele Dokumentvorlagen mit einer anderen Komponentennamenskonvention automatisiert haben, unpraktisch sein, aber für diejenigen, die gerade erst anfangen, ist es vielleicht eine Überlegung wert: Verwenden Sie "CamelCase" oder "Title_Case_With_Underscores", wenn Sie Ihre Komponenten benennen, wie ich es in den obigen Beispielen getan habe.
Traditionell haben viele Vorlagenentwickler die ungarische Notation verwendet, um den Komponententyp zu kennzeichnen (z. B. TE für Text), und viele haben zur besseren Lesbarkeit Leerzeichen in Komponentennamen beibehalten. Die Argumente für die Verwendung der ungarischen Notation haben seit HotDocs 5 an Bedeutung verloren, da neuere Versionen von HotDocs es den Vorlagenentwicklern ermöglichen, die Komponententypen im Komponentenmanager als Symbole oder Text anzuzeigen und sie einfach zu suchen und zu sortieren. Durch das Weglassen von Leerzeichen in Komponentennamen kann der Vorlagenentwickler mehr der 50 zugewiesenen Felder mit aussagekräftigen Zeichen füllen, die die Funktion einer Komponente beschreiben. Darüber hinaus ist die Verwendung von Komponentennamen ohne Leerzeichen (z. B. "CamelCase") der Standard für die Entwicklung von HotDocs-Modellen (ein Thema, das einen zukünftigen Blogbeitrag wert ist). Wenn Sie diese Konvention befolgen, kann HotDocs das Modelldokument lesen und die Variablennamen ohne Leerzeichen in Eingabeaufforderungen im Interview umwandeln, ohne dass es zu Fehlern kommt, wenn die strenge Namenskonvention deaktiviert ist.
Schließlich ist zu bedenken, dass im Zuge der Weiterentwicklung von HotDocs und der Angleichung an andere kompatible Technologien die Notwendigkeit entstehen könnte, dass Benutzer Leerzeichen aus ihren Komponentennamen entfernen müssen. In diesem Fall würde HotDocs eine Möglichkeit bieten, die Komponenten mit Leerzeichen zu konvertieren, aber wenn Sie von vornherein keine Leerzeichen verwenden, sind Sie der Herde einen großen Schritt voraus. Letztendlich ist die HotDocs-Skripterstellung ist eine Programmiersprache, und daher sollte die Konvention für die Benennung von Komponenten nicht nur für die Entwicklung von HotDocs-Vorlagen geeignet sein, sondern auch für andere Programmier- oder Skriptsprachen.
Viel Spaß beim Entwickeln!
Anmerkung der Redaktion: Dieser Beitrag wurde ursprünglich veröffentlicht auf HotDocs.com. Im Juni 2024 erwarb Mitratech die fortschrittliche Dokumentenautomatisierungsplattform HotDocs. Der Inhalt wurde seither aktualisiert und enthält nun Informationen, die auf unser Produktangebot, Änderungen der Vorschriften und die Einhaltung von Vorschriften abgestimmt sind.
