代码之家  ›  专栏  ›  技术社区  ›  patentfox

登录其他人的代码

  •  1
  • patentfox  · 技术社区  · 16 年前

    我刚刚开始开发一个C#应用程序(使用log4net)。我应该给别人写的代码添加日志。因此,我不可能每次都很好地理解上下文(太多的代码,太少的时间:)。

    我一直在遵循一个看起来很粗鲁的惯例。我在每个日志中显示日志级别、日期时间、类名、方法名。我在进入和退出每个方法(大多数方法,我试图在大循环中排除方法)、构造函数、一些事件和每个catch语句时打印日志。

    我想我在某些地方做得太多了,但需要一定程度的一致性。对正确(或更好)的方法有什么建议吗?

    4 回复  |  直到 16 年前
        1
  •  6
  •   Joe Ratzer    16 年前

    记录每个方法的开始和结束以及构造函数,肯定是过分了。

    我担心如果你不了解方法,你就无法记录适当的问题。

    至少要记录所有异常,不要在不处理异常的情况下捕捉异常。

        2
  •  2
  •   Adesit    16 年前

    我建议,你首先找出现在需要日志的原因。毕竟,您正在处理的代码显然是在没有太多日志记录的情况下开发的,所以他们希望您添加日志记录的原因是什么:他们在查找错误(什么类型的错误?)时有问题吗他们是否希望能够在回顾时看到程序做了什么(这是什么?)?

        3
  •  1
  •   weismat    16 年前

    在我的pov中,可以用输入参数记录每个函数/构造函数并在调试中得到结果。
    但是尽可能简短地保存日志消息,因为大多数数据可以通过log4net配置添加/更改。因此仅记录 parameter1: value1 parameter2: value2 和 result:x

        4
  •  0
  •   tonyjy    16 年前

    也许您还应该考虑记录重要的条件语句及其分支(条目),例如if/else if/else和switch/case/default等。这将帮助您在方法中提供更多的逻辑细节。