search

nus-cs2113-AY2223S1 / forum

4 stars 0 forks source link

Question regarding usage of "@author" tag in header comments #28

Closed chydarren closed 2 years ago

chydarren commented 2 years ago

Hello! My team wish to seek a clarification. May I please find out whether we are allowed to use the "@author" tag in header comments of our functions related to our user story to credit our original authors in our code? Thank you!

okkhoy commented 2 years ago

It is up to the team to decide how things need to be done. Normally, whoever wrote the code will be given credit. Using @@author tags will override the normal case, so the team should agree and have a common understanding about claiming contributions.

chydarren commented 2 years ago

Hello Prof, the team have just read your email about the steps available on the module website and we will follow the convention introduced. Thanks for addressing the concern by the team.