Zunächst ein paar Hintergrundinformationen: Mein aktueller Entwicklungsmanager nutzt Ende dieser Woche eine weitere Gelegenheit und verlässt unser Team mit vier Vollzeitentwicklern, einem Teilzeitpraktikanten und einem Webdesigner (der technisch Teil des Marketings ist, nicht AppDev). Derzeit befördern oder stellen wir keinen neuen Manager ein.
Der vorherige Manager würde sich nie die Zeit nehmen, eine Reihe von Codierungsstandards zu entwickeln, um diese einzuhalten (um dies ins rechte Licht zu rücken: Mein einjähriges Jubiläum bei diesem Job ist in zwei Wochen und ich habe seitdem mit ihm über Standards gesprochen Ich habe begonnen). Aus diesem Grund schreiben wir alle vier Entwickler Code auf unsere eigene Weise: Einige von uns folgen den Microsoft-Namenskonventionen für .NET, andere verwenden die ungarische Notation, andere verwenden eine Mischung (z. B. Mischen PascalCase
und camelCase
für Parameternamen), und es ist völlig zufällig, wenn Sie öffnen eine Codedatei nach dem Standard, dem sie folgen wird. Das einzige, was konsistent ist, ist, dass geschweifte Klammern in separaten Zeilen stehen.
Zwei meiner drei Mitarbeiter haben sich an mich gewandt, um ein Standard-Codierungsdokument zu erstellen, das wir verwenden und in Zukunft durchsetzen können (obwohl ich technisch gesehen nicht der älteste Entwickler bin, der vierte Entwickler ist seit mehreren Jahren hier, zwei Mitarbeiter und der Praktikant bittet mich um Rat / Anleitung, aber wir haben keinen Teamleiter). Ich hatte vor, dies für eine Weile zu tun, aber der jetzt abtretende Manager würde es immer in den Hintergrund rücken; Seine Abreise gibt uns jetzt die Möglichkeit, uns etwas Zeit zu nehmen und die Dinge richtig zu konfigurieren, um eine ordnungsgemäße Softwareumgebung zu ermöglichen, und nicht das überstürzte Durcheinander, das wir derzeit haben.
Wie soll ich vorgehen und diesen Standard meinem Team vorstellen, ohne Reibungspunkte zu verursachen? Ich möchte nicht, dass es so aussieht, als würde ich "übernehmen", obwohl mir die Managerposition angeboten würde, würde ich sie akzeptieren. Wie ich bereits sagte, sind zwei von drei anderen Entwicklern an Bord, um einen zu erstellen, aber der vierte (der wahre "Senior" in der Zeitspanne) kann dies akzeptieren oder auch nicht. Ich habe vor, mit den .Net-Konventionen von Microsoft zu beginnen (z. B. keine ungarische Notation verwenden), einige persönliche Präferenzen hinzuzufügen (z. B. _camelcase
für Felder) und bestimmte seltsame Praktiken, die wir hier verwenden, als nicht zu verwenden zu bezeichnen (z. B. eine Klasse mit zu benennen) ein Unterstrich am Anfang), aber was soll ich noch einschließen? Ich möchte nicht auf architektonische Richtlinien eingehen verursachen Reibung und wir haben eine sehr große und stinkende vorhandene Codebasis, die sich nicht daran halten würde, und wir sind noch lange nicht in der Lage, eine Refactoring-Strategie zu entwickeln.
Zusammenfassend: Über grundlegende Namenskonventionen hinaus, was, wenn überhaupt, sollte ich in ein Dokument mit Codierungsstandards aufnehmen (Beispiele wären großartig - ich habe keine konkreten Beispiele dafür gefunden, wie ein solches Dokument aussehen sollte) und wie sollte ich Präsentieren Sie es meinem Team, ohne wie der neue Diktator zu klingen.