[MITgcm-support] Re: Reminder on TAMC-friendly programming

[Patrick Heimbach]

Jean-Michel,
I agree.
Cheers
-p.

Jean-Michel Campin wrote:
> Hi patrick,
> 
> I think generally we don't need to put comments like:
> 
> cswdblk -- add ---
>       LOGICAL useBulkforce
>       LOGICAL useThermSEAICE
> cswdblk --- end add ---
>       COMMON /PARM_PACKAGES/
>      &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
>      &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
>      &        usePTRACERS,  useSBO, useSEAICE,
> cswdblk -- add ---
>      &        useThermSEAICE, useBulkforce
> cswdblk --- end add --- 
> 
> because 
> 1) source files that are often modified can become rapidly full of
>   those comments, and not very helpfull at the end, nor very clear
>   when someone looks to the code.
> 2) concerning more independant piece of code that are added, they 
>   often comes with a CPP_OPTION that is easy to grep through the code.
>   so, no real need for those comments.
> 3) one can easily see "who added what" with the cvs-webb option "anotate":
> 
> 1.86      dimitri   637:       LOGICAL useSBO
> 1.80      heimbach  638:       LOGICAL useSEAICE
> 1.81      cheisey   639: cswdblk -- add ---
> 1.82      cheisey   640:       LOGICAL useBulkforce
>                     641:       LOGICAL useThermSEAICE
> 1.81      cheisey   642: cswdblk --- end add ---
> 1.44      adcroft   643:       COMMON /PARM_PACKAGES/
> 1.91      jmc       644:      &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
> 1.69      adcroft   645:      &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
> 1.86      dimitri   646:      &        usePTRACERS,  useSBO, useSEAICE,
> 1.81      cheisey   647: cswdblk -- add ---
> 1.82      cheisey   648:      &        useThermSEAICE, useBulkforce
> 1.81      cheisey   649: cswdblk --- end add ---
> 
> What do people think about this ?
> 
> Cheers,
> 
> Jean-Michel


-- 
_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
Patrick Heimbach ............................. MIT
FON: +1/617/253-5259 .......... EAPS, Room 54-1518
FAX: +1/617/253-4464 ..... 77 Massachusetts Avenue
mailto:heimbach at mit.edu ....... Cambridge MA 02139
http://www.mit.edu/~heimbach/ ................ USA