Psalm- oder PHPStan-Regeln zur Durchsetzung von Aktualisierungen von DocBlocks?Php

PHP-Programmierer chatten hier
Guest
 Psalm- oder PHPStan-Regeln zur Durchsetzung von Aktualisierungen von DocBlocks?

Post by Guest »

Gibt es eine Möglichkeit, Psalm oder PHPStan anzuweisen, sicherzustellen, dass alle aktualisierten Methoden auch aktualisierte DocBlocks erhalten?
Dies ist eine häufige Herausforderung in Softwareentwicklungsteams. Ein DocBlock wird während der ersten Erstellung einer Methode geschrieben. Dann ändert sich die Methode und der DocBlock ist veraltet und ungenau.
Wenn es eine einfache Möglichkeit gibt, meiner CI-Pipeline (oder sogar einem Git-Hook) mitzuteilen, dass ein DocBlock vorhanden ist Gefahr der Ungenauigkeit, das würde ich gerne tun. Wenn es kein solches Tool gibt, würde ich gerne eines als kleines Nebenprojekt erstellen.
===
EDIT: Das hoffe ich um anzeigen zu können, wenn sich ein nicht maschinenlesbarer Kommentar geändert hat. Die Tags „@since“ und „@version“ sind hierfür Optionen, aber ich würde mir idealerweise wünschen, dass ein Datum oder ein einzelner Commit angezeigt wird, da diese detaillierter wären. Daher wäre meine Pipeline idealerweise in der Lage, zu testen, ob ein für Menschen lesbarer Kommentar aktualisiert wurde, wenn die entsprechende Methode aktualisiert wurde, und sich zu beschweren, wenn nicht.

Quick Reply

Change Text Case: 
   
  • Similar Topics
    Replies
    Views
    Last post