有没有更好的方式在代码中注释参数的方向？
有没有更好的方式在代码中注释参数的方向？
提问于 2012-03-02 14:43:19
我想提高代码的可读性。所以我在代码中注释了参数的方向，如下所示：
#define IN
#define OUT
void Add(IN int Para1, IN int Para2, OUT int& Result);但我认为编译器会用空格替换IN和OUT的每个实例，有时这可能是一个相当大的问题。
那么有没有更好的方法呢？谢谢。
(我使用C++。)
回答 9
Stack Overflow用户
回答已采纳
发布于 2012-03-02 14:49:23
是:忘掉这些事情，使用常量。只要你没有"in“和"out”参数，这将会起作用，这是并且应该很少使用。
void foo(int i, const std::string& s, std::vector<char>& out_buf);
// i and s are obviously "in" variables, while out_buf could be both,
// but you can easily show that by giving the parameter a proper name.编辑:常量正确性并不意味着将值参数设为常量！这根本不会给调用者提供任何额外的信息，因为您不能以任何一种方式更改他的变量。
Stack Overflow用户
发布于 2012-03-02 14:48:33
你可以试着把它放在评论里。这是更好的和可读性更好。
void Add(/*IN*/ int Para1, /*IN*/ int Para2, /*OUT*/ int& Result);Stack Overflow用户
发布于 2012-03-02 14:55:26
我可以想出两种简单的方法来解决这个问题。
1.
/*Description : Function for adding the two variables.
* Returns : Nothing
* Parameters : Para1 and Para2 are **IN** parameter and
* Result is an **OUT** parameter
* @author : <put ur name here>
*/
void Add(IN int Para1, IN int Para2, OUT int& Result);除了这些基本信息外，您还可以存储版本号、创建日期等信息。
2.您还可以在变量名中嵌入参数类型信息，即inPara1、inPara2和outResult。例如
void Add(int inPara1,int inPara2,int& outResult);还有一件事，我建议变量和函数名使用驼峰式大小写字母，例如，Para1可以作为para1，等等，这将在将来对你有所帮助。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/9529152
复制相关文章
相似问题
腾讯云开发者
