开发者

Does adding meta-information suffice for including myself as additional @author of a class?

开发者 https://www.devze.com 2023-04-11 04:37 出处:网络
Me and my colleague are in the process of developing domain model for a small part of our project. Recently he committed skeleton entity classes to our SVN repository without adding JPA annotations. A

Me and my colleague are in the process of developing domain model for a small part of our project. Recently he committed skeleton entity classes to our SVN repository without adding JPA annotations. At the same time I have designed physical data model and created corresponding database objects. Now I need to map the entity classes to the database, making various decisions about inheritance strategies and other things. Does annotating classes qualify me as additional @author? I know that typically, additional @author tag could be added when some crucial changes had been made to the class. But what if I provid开发者_运维技巧e only meta-information?

Edit:

It's not about ego. It's about whether it's common and considered a good practice.

Some say @author tags are useless, since the code is under version control anyway.

But I personally don't think so. This tag could be quite useful in some cases.


I always add @author to classes I make substantial contributions too. I run into many instances where a colleague has created the skeletons, or something not complete, where I added myself as an @author as well.

To me, it's not about ego, but more so a quick reference for someone else who has to look at the file without them having to go back through version control logs if they need information.


Don't let egos get in the way of software. Do you really care?

Anyway, designing the JPA annotations, hierarchies, and related code is much more difficult than creating skeleton entities, so if you really care, then add it.

Note that your VCS will keep track of who is contributing what work, so there will always be a single point of truth for who put what code where in the app.


In my opinion it's ok to add yourself as @author. Configuring JPA annotations may not be that easy. If you are not sure ask your colleague. Having a SVN (and separate accounts) it's easy to find out who made what.

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号