How indicate when a functions was upgraded in relationship to the entire program

for inline documentation there are those @somethings for some php documenter, when

there is the common @since @version and so on.

I have a lot of functions that are all part of a big package. But what if i want to indicate when i last updated a function and show on what version of the mayor package it was done?

should i just use @version and give the function the version of the entire package?

In case i cause confusion:

lets say i have a function with @since 0.1 in my program 1.0. then the program itself gets developed up to 2.9 and for the 3.0 version the function would have a change.

So actually the functions version would be 0.2 now but i want to show on what version of my entire programm it was updated. So should i just jump and say @version 3.0 at this function?

i just used a @updated but thats not existing right? nothing like this documented here

Is there anything for my purpose?

Topic documentation comments Wordpress

Category Web

1
answered at

Inline docs are the place to track changes. There are better tools for that: revision control. Use Git, Mercurial or – if you want to stay old-school ;) – SVN.

Each time you change something, you make a commit: A short note explaining the difference between the last and the new version (example).

Usually, when you look at source code you want to know what it does right now. And why. These docs are important. Everything else, including @since, doesn’t really belong to comments.

About

Geeks Mental is a community that publishes articles and tutorials about Web, Android, Data Science, new techniques and Linux security.