可冰

冰,是沉睡着的水......

  C++博客 :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理 ::
  37 随笔 :: 5 文章 :: 94 评论 :: 0 Trackbacks

        在C/C++中,变量及函数的定义一般都是在.h/.hpp文件中说明原型,而在对应的.c/.cpp文件中来进行实现.
        这种情况下,头文件最终是给用户使用的,以便让用户了解有哪些接口可以使用;而.c/.cpp文件是开发者使用的,以便让其它开发人员了解它的实现逻辑.因此这两个文件中肯定都是需要详细的注释的.在.h/.hpp文件中,主要说明函数的使用方法,如参数的意义,返回值的定义等.而.c/.cpp文件中,主要说明函数的实现逻辑等.

        不知道上面的做法是否合适.请大家指正!
        另外,大家在实际编程过程中是如何做的?

        事实上,我自己在实践过程中却总是偏向于把注释写到一个地方,或者注释原型,或者注释实现(前者比较多),甚至干脆两边都写一样的(但这样的话内容经常会不一样).这样的方法让我在编程过程中吃尽了苦头哇.

posted on 2006-04-21 15:20 可冰 阅读(545) 评论(3)  编辑 收藏 引用 所属分类: C++

评论

# re: [讨论]关于注释的书写位置 2006-04-24 13:21 oosky
对于接口,还是写在.H中比较好,详细设计写在.cpp中比较好。  回复  更多评论
  

# re: [讨论]关于注释的书写位置 2008-07-24 14:49 秒大刀
我西习惯于将注释写再头文件中,至于代码具体的细节则写在cpp中,另外也可以给cpp中的函数加上简洁的说明  回复  更多评论
  

# re: [讨论]关于注释的书写位置 2008-10-29 11:54 @秒大刀


我现在的做法是这样的,所有的实现代码都写在H文件,基本上一个项目就只有几个CPP文件。这样做是类似于java的写法。最终编译之后,生成的二进制代码没有区别。
当然,如果要在多个项目依赖使用,那还是要分开的,如果仅在一个项目内部使用,我觉得都写在头文件里是很好的方式。

  回复  更多评论
  


只有注册用户登录后才能发表评论。
【推荐】超50万行VC++源码: 大型组态工控、电力仿真CAD与GIS源码库
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理