Richtlinien für die Überprüfung des Entwurfs und des Codes

Im Folgenden werden einige Richtlinien die Überprüfung des Entwurfs und des Codes vorgestellt.

Erforderlich

• Nehmen Sie sich für die Überprüfung genügend Zeit.

  Zweck der Überprüfung ist es, den Entwurf und den Code vollständig zu verstehen und zu analysieren. Planen Sie für die Überprüfung noch einmal ungefähr die Hälfte der Zeit ein, die für das Verfassen des Codes bzw. den ursprünglichen Entwurf aufgewendet wurde.

• Übertragen Sie den Bearbeitern die Verantwortung für die Überprüfung.

  Der zentrale Aspekt einer Überprüfung sind die Kommentare der Bearbeiter. Wenn Entwickler die Überprüfung ihrer eigenen Arbeit leiten, besteht die Gefahr, dass andere Bearbeiter Probleme übersehen.

• Lesen Sie vor der Besprechung der an der Überprüfung Beteiligten den Code oder das Entwurfsdokument.

  Bereiten Sie sich im Voraus auf die Besprechung vor, es sei denn, es sollen nur sehr geringfügige Änderungen überprüft werden. Wenn die Bearbeiter sich nicht gründlich durch die Lektüre des Codes oder Entwurfsdokuments auf die Besprechung vorbereiten, ist die Besprechung für alle Beteilgten eine reine Zeitverschwendung.

• Verwenden Sie für Überprüfungen in der Gruppe ein Teamprojektportal.

  Veröffentlichen Sie die Entwurfsdokumente in einem Projektportal, sodass alle Beteiligten sie problemlos finden und überprüfen können. Senden Sie einen Zeiger auf das veröffentliche Dokument an die Bearbeiter, und bitten Sie diese, ihre Kommentare mithilfe des Diskussionsfeatures von Internet Explorer hinzuzufügen. Wenn auch der Code auf diese Weise überprüft werden soll, fügen Sie den Code in ein Word-Dokument ein, und veröffentlichen Sie dieses ebenfalls auf einer SharePoint-Website. Weitere Informationen finden Sie unter Planen und Nachverfolgen von Projekten.

• Verwenden Sie eine Prüfliste.

  Es kann leicht passieren, dass man sich ausschließlich auf bestimmte Aspekte einer Überprüfung konzentiert, z. B. Sicherheit, Fehlerbehandlung oder Stil. Möglicherweise sind Sie versucht, sich anderen Aufgaben zuzuwenden, obwohl Sie nur einen einzigen Aspekt bearbeitet haben. Anhand von Prüflisten können Sie die zahlreichen Aspekte der Überprüfung systematisch abarbeiten.

• Dokumentieren Sie alle während der Codeüberprüfung gefundenen Probleme.

  Dokumentieren Sie Probleme als Arbeitsaufgaben, als Kommentare im Code oder als Probleme in den Entwurfsdokumenten. Andernfalls geraten einzelne Probleme möglicherweise in Vergessenheit, und die Codeüberprüfung war verlorene Zeit. Weitere Informationen finden Sie unter Erstellen einer Arbeitsaufgabe.

Vermeiden

• Ändern Sie den Code oder den Entwurf nicht, ohne die Bearbeiter darüber zu informieren.

  Möglicherweise finden Sie noch Fehler in Ihrem Entwurf oder Code, nachdem Sie diesen zur Überprüfung versendet haben. Verzichten Sie unbedingt darauf, diese Fehler vor der Besprechung zur Überprüfung zu korrigieren. Wenn Sie den Code oder Entwurf vor der Besprechung ändern, stiften Sie Verwirrung bei der Überprüfung, und die Bearbeiter werden davon nicht eben begeistert sein. Handhaben Sie daher gefundene Fehler so, als wären Sie der Bearbeiter, d. h., notieren und dokumentieren Sie diese zusammen mit allen anderen Kommentaren aus der Überprüfung.

Empfohlen

• Beziehen Sie Vertreter aller Disziplinen in die Überprüfung ein.

  Zwar ist es nicht immer möglich, außer der Entwicklung noch weitere Disziplinen in die Überprüfung von Entwürfen und Code einzubeziehen, aber wenn dies möglich ist, können die Vertreter anderer Disziplinen möglicherweise auch sehr versteckte Probleme aufspüren. Eine oder zwei Personen pro Disziplin reichen völlig aus. Werden mehr Personen hinzugezogen, sind die Überprüfungen zeitintensiv und schwierig zu verwalten.

• Überprüfen Sie den gesamten Code und alle Entwürfe.

  Planen Sie für Ihre gesamte Arbeit Code- und Entwurfsüberprüfungen ein, um eine optimale Produktqualität zu erzielen. Die Überprüfung sollte eine Codeanalyse und Komponententests sowie das Dokumentieren des Entwurfs zu Beginn umfassen.

• Erwägen Sie das Erstellen von Shelvesets, um die Codeüberprüfungen zu verwalten.

  Sie können ein Shelveset erstellen, das nur die Änderungen enthält, die die Bearbeiter untersuchen sollen. Wenn Sie ein Shelveset erstellen, geben Sie die Änderungen für die Bearbeiter frei, ohne diese Änderungen in der Versionskontrolle einzuchecken. Weitere Informationen finden Sie unter Arbeiten mit Shelvesets.

Siehe auch

Konzepte

Analysieren der Anwendungsqualität mit Codeanalysetools

Verbessern der Codequalität mit Eincheckrichtlinien für das Teamprojekt