Annotations could have automated date- and user-tags. - Mendix Forum

Annotations could have automated date- and user-tags.

3

In our company annotations in StudioPro are used to clarify certain functionality in microflow and often changes that have been made. 

Our current best practice is to start each annotation with a date and a name so that someone reading the annotation years from now gets a sense of why and how that code came to be. When a developer forgets this best practice, an annotation can feel senseless and absolete. i.e. 'can be removed after christmas'.

 

Automatically logging the developers name and date/time of when the annotation was created and/or changed overcomes the possibility of someone unintentionally forgetting to abide the best practice. Perhaps even stories could be linked to the annotation for easier research to what an annotation actually means.

 

Yes, I understand that just properly writing an annotation also mitigates this problem but I believe we've all been in the position there was not enough time to properly describe everything and the best you could do was write a quick annotation. This idea helps to provide some additional info in those situations.

 

Kind regards,

 

asked
1 answers

This would be a nice addition.

Created