当前位置:  开发笔记 > 编程语言 > 正文

DRY XML评论

如何解决《DRYXML评论》经验,为你挑选了0个好方法。

当提供相同方法的多个重载时,我经常不得不重复该方法的描述,这违反了DRY并增加了维护成本:

/// 
/// Frobnicates all foos read from the given reader. Frobnication is a
/// process where ...[lots of text]...
/// 
/// [Description of hasBar]
void FrobnicateFoo(TextReader reader, bool hasBar)
{
    ...
}

/// 
/// Frobnicates all foos read from the given file. Frobnication is a
/// process where ...[same lots of text]...
/// 
/// [Same description of hasBar]
void FrobnicateFoo(String path, bool hasBar)
{
    ...
}

如果重复具有相同目的的多个参数,则该问题变得更糟(作为示例给出"hasBar").

我找到的一个"解决方法"是"引用"其他文档:

/// 
/// Frobnicates all foos read from the given reader. Frobnication is a
/// process where ...[lots of text]...
/// 
/// [Description of hasBar]
void FrobnicateFoo(TextReader reader, bool hasBar)
{
    ...
}

/// 
/// Convenience method which opens the file with a UTF-8 encoding and then
/// frobnicates all foos, see FrobnicateFoo(TextReader).
/// 
void FrobnicateFoo(String path, bool hasBar)
{
    ...
}

显然,这对于图书馆的用户来说不太方便.

是否有一些内置机制(或智能策略)可以用来避免重复让我的方法的用户轻松生活?我主要关注IntelliSense,而不是生成的HTML文档.

推荐阅读
刘美娥94662
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有