Take the 2-minute tour ×
WordPress Development Stack Exchange is a question and answer site for WordPress developers and administrators. It's 100% free, no registration required.

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?

share|improve this question

closed as off topic by Stephen Harris, toscho Jul 8 '12 at 19:49

Questions on WordPress Development Stack Exchange are expected to relate to WordPress within the scope defined by the community. Consider editing the question or leaving comments for improvement if you believe the question can be reworded to fit within the scope. Read more about reopening questions here.If this question can be reworded to fit the rules in the help center, please edit the question.

    
The question is not about WordPress, it’s about software development in a wider scope. I wanted to move to programmers but they don’t want it. –  toscho Jul 8 '12 at 19:51
    
Yeah i know, i can't post in SO anymore so i did this here. Could have been migrated, but why bother just close thanks for nothing. –  amy Jul 9 '12 at 1:33
add comment

1 Answer 1

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.

share|improve this answer
    
I use Git. And this is not answering the question its just a lecture you gave because you expect me to be stupid, i want to see exactly that in my source even if i use git. So i will just use @updated even if it not exists. It's for humans, i just wanted to know it there it something for this purpose then i would have done is for humans and robots at the same time and no lecture about what YOU would do. –  amy Jul 9 '12 at 1:26
add comment

Not the answer you're looking for? Browse other questions tagged or ask your own question.