Frontend: Dokumentation
@lg58weky sagt: Man versteht im Frontend einfach gar nichts, die Doc sollte an die lupenreine Doc vom backend angepasst werden.
Die Intention der einzelnen Komponenten im Frontend sollte grob dokumentiert werden. Eine Möglichkeite dafür wäre eine kurze Section in der Frontend-README mit einem Satz pro Komponente.
Todo
-
Javscript-Funktionen dokumentieren -
Komponenten-Properties ( props
) dokumentieren -
Pro Komponente eine Kurzbeschreibung in der Frontend README
Siehe auch Vue-Style-Guidst: Documenting components
Beispiele
- Funktions-Dockblock:
/**
* <summary, one sentence>
*
* <description>
*
* @param <param1> <paramType1>: <param1 description>
* @param <param2> <paramType2>: <param2 description>
* <...>
*
* @returns <returnType>: <return value description>
*/
Edited by Lukas Gehrke