【问题标题】:Naming convention between namespaces and classes in C++? [closed]C ++中命名空间和类之间的命名约定? [关闭]
【发布时间】:2013-02-02 05:45:27
【问题描述】:

创建一个名为“snap”的库,我想要一个名为“log”的类,我将它放在一个子命名空间中。如果命名空间也是“日志”可以吗? (我知道它在技术上可行,我想知道正确的命名约定,你会怎么做?)

namespace snap
{
  namespace log
  {
    class log {
      ...
      enum log_level_t { ..., LOG_LEVEL_ERROR, ... };
      ...
    };
  }
}

问题是我们最终会得到这样的结果:

snap::log::log::log_level_t ll(snap::log::log::LOG_LEVEL_ERROR);

你觉得这很奇怪吗? (即双 ::log::log)

【问题讨论】:

  • Log::log 看起来不错。让我想起了Post Versalog
  • 我看不出这个问题的答案对你有什么帮助。我们既不是您的同事,也不是我们代码的未来用户。我们的意见并不重要。重要的是组织的编码约定或与您合作的团队的意见。
  • 好吧,我正在开发一个免费项目,因此用户将是任何认为它有用的人。出于这个原因,我认为向社区寻求建议并没有超出范围。我的组织已根据来自不同社区的意见制定了约定。

标签: c++ namespaces convention


【解决方案1】:

我不知道你为什么在类中定义了枚举。如果你有一个专门用于日志的命名空间,那么在命名空间中定义所有与日志相关的东西。所以我更喜欢这个:

namespace snap
{
  namespace log
  {
     enum log_level_t { ..., LOG_LEVEL_ERROR, ... };
     class log { };
  }
}

此外,由于命名空间log 本身暗示了其中定义的内容,与日志记录相关(或应该与日志记录相关),我觉得log_level_t 中的log 部分似乎是重复的。我会将上述内容进一步重构为:

namespace snap
{
  namespace logging //renamed
  {
     enum class level_t{verbose, info, error, ... }; //renamed, and used enum class!

     class logger { ... }; //renamed
  }
}

或者,我会选择名称severity 而不是level_t。无论如何,我认为使用变得更好:

logger.write(snap::logging::severity::error, message, etc);

或者你可以写一些友好的函数,这样你就可以这样写:

logger.verbose(message, etc);
logger.info(message, etc);
logger.error(message, etc);
//etc

希望对您有所帮助。

【讨论】:

  • 我喜欢日志和记录器。对于级别的名称,我将保持这种方式,因为我使用 log4cplus 作为后端,并且我们使用类似的东西(它在 syslog 中也称为级别)。我也有友好的函数,虽然这些是创建记录器的全局变量,然后与 () 运算符一起使用,析构函数将结果发送到实际的 log4cplus 记录器。我在这里展示了一个更完整的实现:stackoverflow.com/questions/3213571/g-function-replace-time/…
猜你喜欢
  • 2016-12-25
  • 1970-01-01
  • 2023-03-22
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2011-10-03
  • 2016-03-25
  • 1970-01-01
相关资源
最近更新 更多