Question

我必须从以下主要函数中调用函数：

void main()
...
...
...
printf("Starting function- saveSubscriber");
  status = saveSubscriber(io_ctr,
                   i_pRec,
                   /*&ufpEsn,*/     **/* Change #6*/**
                   iov_pmktbuf,
                   &i_pCntRec,       **/* Change #23 */**
                   iv_pActvBuf->pr ); 

...
...
}

注释是否放在参数旁边（ / *更改＃6 * / 和 / *更改＃23 * / ）？也就是说，代码将被编译并且其功能将与没有注释时的功能相同。

Answer 1

注释语法很好。

对我来说，对参数进行注释是一个标志，表明没有清楚选择参数的名称。

此外，注释掉完整的内容使我有些困惑。好像有人更改了功能的签名，而且懒得无法正确清理它。

Answer 2

这很好，就像其他人所说的那样。

但是，如果使用有意义的变量名，您也许可以避免这种情况。

我还发现自己声明了许多不同名称的枚举，这些枚举基本上只是布尔值。

哪个更清晰？

1）

processData(1);  // you might add acomemnt to explain what 1 means.
                 // Many won't bother (especially those @~£%$!! who write  
                 // code that I have to main years later !!)

2）

#define TRUE 1
#define FALSE 0
...

processData(TRUE);

3）

typedef enum {deleteDuplicates, retainDuplicates} howTohandleDuplicates_t;

processData(deleteDuplicates);

始终尽力编写可维护，易于阅读的代码。注释很好，但是精心选择的变量名可以消除对大多数变量的需求

将注释放在C中的函数调用的参数之间可以吗？

2 个答案: