如何使这段代码更具可读性？

Question

我今天写了这篇文章，我感到很羞愧。我需要做什么才能使这些混乱的东西变得更加准确和可读？

switch ((RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType)Enum.Parse(typeof(RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType), ihdType.Value))
    {
            //REF:This can (but should it?) be refactored through strategy pattern
        case RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType.ReportPlanWithEffects:
            grvEconomicCriteria.DataSource = RequestReportsCalculatingStoredProcedures.ReportsDataParser(
                            RequestReportsCalculatingStoredProcedures.ReportPlanWithEffects(requestNo, RequestReportsCalculatingStoredProcedures.GetAlgorithmNoByRequestNo(requestNo)));
            break;
        case RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType.ReportPlanWithEffectsForFacts:
            DateTime factDate;
            try
            {
                factDate = Convert.ToDateTime(ihdDate.Value);
            }
            catch(FormatException)
            {
                grvEconomicCriteria.DataSource = RequestReportsCalculatingStoredProcedures.ReportsDataParser(
                            RequestReportsCalculatingStoredProcedures.ReportPlanWithEffectsForFacts(requestNo, RequestReportsCalculatingStoredProcedures.GetAlgorithmNoByRequestNo(requestNo), DateTime.MinValue));
                break;
            }
            grvEconomicCriteria.DataSource = RequestReportsCalculatingStoredProcedures.ReportsDataParser(
                            RequestReportsCalculatingStoredProcedures.ReportPlanWithEffectsForFacts(requestNo, RequestReportsCalculatingStoredProcedures.GetAlgorithmNoByRequestNo(requestNo), factDate));
            break;
        default:
            break;
    }

Answer 1

您始终可以为超长类型使用别名RequestReportsCalculateStoredProcedures：

using RRCSP = RequestReportsCalculatingStoredProcedures;

注意：您需要在 using 指令中使用完全限定名称（包括命名空间）。

Answer 2

除了其他人所说的缩短名称等之外，您应该考虑将代码从 case 语句中提取到函数调用中，这样您最终会得到类似的内容，

switch (myMassiveVariable)
{
    case RequestReportStoredProcedureType.ReportPlanWithEffects:
        RunReportWithEffects(requestNo);
        break;
    case RequestReportStoredProcedureType.ReportPlanWithEffectsForFacts:
        RunReportWithFacts(requestNo);
        break;
}

这有助于整理一些东西。

Answer 3

我坚信描述性变量、类和方法名称。我总是会选择清晰而不是简洁，但是一个易于实施的规则是，如果你的名字中有一部分总是重复，你可以将其删除。例如，您有：

RequestReportsCalculateStoredProcedures

这很好。它清楚地解释了它是什么。但是，该类或对象的成员也以该名称开头，并在末尾加上不同的名称。例如：

RequestReportStoredProcedureType

这可以缩写为 StoredProcedureType，甚至可以缩短为 procedureType。

我知道许多程序员会争论诸如 RRCalcSP 之类的东西或其他一些完全不清楚的命名约定，但我永远不会为了避免换行等而牺牲命名清晰度。

老实说，您在原始示例中所拥有的内容并不混乱或可耻。它太长了，您必须处理换行。

此外，大量使用注释可以使事情变得更加清晰。

Answer 4

老实说，这里最大的问题之一就是变量名称的长度。

显然，你应该给出变量/类型/等。描述性名称。但到了一定程度就变得有点极端了。我工作中的一个人因给方法命名而臭名昭著，例如：

DoSomethingVerySpecificHereIsOneOfItsSideEffectsAndHereIsAnother

在您的情况下，我注意到大量的冗余。例如，您有一个名为 RequestReportsCalculateStoredProcedures 的类，然后在该类中您似乎有一个名为 RequestReportStoredProcedureType 的枚举。由于枚举已经是 RequestReportsCalculateStoredProcedures 中的嵌套类型，也许您可​​以将其称为 Type？

或者，缩短这些名称（至少在这个文件中）的非常有效方法是使用简单的 using 声明：

using E = RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType;

然后看看您的代码会发生什么：

using RRCSP = RequestReportsCalculatingStoredProcedures;
using E = RRCSP.RequestReportStoredProcedureType;

// ...

// Note: RRCSP = RequestReportsCalculatingStoredProcedures, and
//       E = RRCSP.RequestReportStoredProcedureType

switch ((E)Enum.Parse(typeof(E), ihdType.Value))
    {
        //REF:This can (but should it?) be refactored through strategy pattern
        case E.ReportPlanWithEffects:
            grvEconomicCriteria.DataSource = RRCSP.ReportsDataParser(
                RRCSP.ReportPlanWithEffects(
                    requestNo,
                    RRCSP.GetAlgorithmNoByRequestNo(requestNo)
                )
            );
            break;
        case E.ReportPlanWithEffectsForFacts:
            DateTime factDate;
            try
            {
                factDate = Convert.ToDateTime(ihdDate.Value);
            }
            catch(FormatException)
            {
                grvEconomicCriteria.DataSource = RRCSP.ReportsDataParser(
                    RRCSP.ReportPlanWithEffectsForFacts(
                        requestNo,
                        RRCSP.GetAlgorithmNoByRequestNo(requestNo),
                        DateTime.MinValue
                    )
                );
                break;
            }
            grvEconomicCriteria.DataSource = RRCSP.ReportsDataParser(
                RRCSP.ReportPlanWithEffectsForFacts(
                    requestNo,
                    RRCSP.GetAlgorithmNoByRequestNo(requestNo),
                    factDate
                )
            );
            break;
        default:
            break;
    }

是这样吗？更具可读性？在我看来，是的，主要是因为它看起来不那么令人畏惧。不过，显然您正在做出权衡，因为您使用的别名不如原始名称​​立即明显。就像其他所有事情一样，这最终取决于个人判断。

Answer 5

如果您对所使用的代码有一定的控制权，我建议：

1. 将枚举 RequestReportsCalculateStoredProcedures.RequestReportStoredProcedureType 引入外部范围。内部名称已经足够详细，您不需要外部名称来澄清。

2. 尝试将长类名替换为能够阐明其意图的名称，而不描述其如何完成工作的细节。

3. 提供不需要算法参数的 RequestReportsCalculatedStoredProcedures.ReportPlanWithEffectsForFacts 的重载，因为您显然可以通过 requestNo 来查找它。当您不需要提供非标准算法时，这消除了对 RequestReportsCalculatedStoredProcedures.GetAlgorithmNoByRequestNo 的详细调用。

Answer 6

诚然，这个答案利用了这个问题的其他答案，但我认为使一些建议更加明确会有所帮助。

我将 RequestReportsCalculateStoredProcedure 类重命名为 RequestReports。对我来说，StoredProcedure 部分似乎是一个与其他人无关的实现细节。我不确定“计算”这个词会带来什么，所以我也删除了它。

我将枚举 RequestReportStoredProcedureType 重命名为 ReportPlan，因为它似乎最适合上下文（ReportType 也是一种可能性）。额外的冗长内容被删除，类似于包含它的类被重命名的原因。我把它留在课堂上，因为它似乎提供了一些上下文，并且随着名称的缩短，这似乎是一个好主意。

从方法调用中删除算法参数的建议，因为它可以从已传递的参数派生，这似乎是一个不错的建议。

鉴于这些更改，代码将如下所示：

switch((RequestReports.ReportPlan)Enum.Parse(typeof(RequestReports.ReportPlan), ihdType.Value)) {
            //REF:This can (but should it?) be refactored through strategy pattern
            case RequestReports.ReportPlan.WithEffects:
                Object reportPlan = RequestReports.ReportPlanWithEffects(requestNo);
                grvEconomicCriteria.DataSource = RequestReports.ReportsDataParser(reportPlan);
                break;
            case RequestReports.ReportPlan.WithEffectsForFacts:
                DateTime factDate;
                try {
                    factDate = Convert.ToDateTime(ihdDate.Value);
                }
                catch(FormatException) {
                    Object reportPlan2 = RequestReports.ReportPlanWithEffectsForFacts(requestNo, DateTime.MinValue);
                    grvEconomicCriteria.DataSource = RequestReports.ReportsDataParser(reportPlan2);
                    break;
                }
                Object reportPlan3 = RequestReports.ReportPlanWithEffectsForFacts(requestNo, factDate);
                grvEconomicCriteria.DataSource = RequestReports.ReportsDataParser(reportPlan3);
                break;
            default:
                break;
            }

Answer 7

查看使用命令。

我也相信（尚未检查），但您可以执行类似以下操作：

RequestReportsCalculatingStoredProcedure myShortCut = RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType;

然后，您可以引用 myShortCut，而不是引用大行。

Answer 8

您可以应用您评论的策略模式，或者使用带有基于类型的委托（Func<> 或 Action<>）的字典来执行某些操作。您可以使用 DateTime.TryParse() 方法来缩短 DateTime try/catch 时间。除此之外，代码中最不可恢复的是长名称，因此您可能需要在开始代码之前将其中一些名称放入变量中

希望它有所帮助

Answer 9

我建议从 case 语句中提取公共部分

RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType dependingOnType =(RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType)Enum.Parse(typeof(RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType), ihdType.Value);

var EssentialData = null;
var AlgorithmChosen = RequestReportsCalculatingStoredProcedures.GetAlgorithmNoByRequestNo(requestNo);

switch (dependingOnType)
    {
            //REF:This can (but should it?) be refactored through strategy pattern
        case RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType.ReportPlanWithEffects:
           EssentialData  = RequestReportsCalculatingStoredProcedures.ReportPlanWithEffects(requestNo, AlgorithmChosen);
            break;
        case RequestReportsCalculatingStoredProcedures.RequestReportStoredProcedureType.ReportPlanWithEffectsForFacts:
            DateTime factDate = Datetime.MinValue;

            if (!DateTime.TryParse(ihdDate.Value, factDate)) {
                factDate = DateTime.MinValue;
            }

               EssentialData  = RequestReportsCalculatingStoredProcedures.ReportPlanWithEffectsForFacts(requestNo, AlgorithmChosen, factDate);

            break;
        default:
            break;
    }

grvEconomicCriteria.DataSource = RequestReportsCalculatingStoredProcedures.ReportsDataParser(essentialData);

编辑来进一步完善它

RequestReportsCalculatingStoredProcedures.GetAlgorithmNoByRequestNo(requestNo)

您可以通过计算唯一一次

：像这样:)