如何编写代码解决问题，初学者指南

 

介绍

这里的所有代码都在C＃中——但这都是非常简单的东西，任何语言的处理过程都是相同的。

最近，存在一个涉及大量作业的问题：编写一种方法来读取文件并返回所有行，然后返回包含三个星号的行。即使对于初学者来说，代码也很糟糕——太糟糕了，我不会因为链接到它而使任何人尴尬。

引用：

大家好，我不知道return方法后面是否有继续执行的选项，或者是否应该构造代码。我想在返回后继续到txt文件的末尾，并让返回列表列出更多值。

public static string FindLineAboveAsterisks(TextReader reader)
        {
            StringBuilder sbBuilder = new StringBuilder();
            string result = reader.ReadLine();
            string line = String.Empty;          

            while  (result is object && (line = reader.ReadLine()) is object)
        {
                int startIndex = 21;
                int length = 9;

            if (line.Contains("***"))
            {
                sbBuilder.AppendLine(result);
                return result;
                    
                }
                {
                    result = line.Substring(startIndex, length);
                }
                
            }
            return string.Empty;

您查看该代码后，就开始怀疑...为什么？那是什么缩进？那有什么用？为什么这样？您希望它如何运作？

当然，事实并非如此。它是行不通的——作者之所以把它放到一起而根本不考虑任务的原因。

我的答案（扩大了一点）

看起来好像是在没有考虑您要做什么的情况下将其放在一起！

冲,我知道。但我想引起他的注意。

扔掉它，然后考虑您的任务：读取文件，找到所有带有星号的行，然后将其返回。

还是很直白，但是让我们想想。

因此，让我们从顶部开始：您需要返回多行——因此，显而易见的事情是返回字符串的集合而不是单个字符串。因为尽管您可以将它们作为单个字符串返回，但对于调用您的方法的代码而言，它的工作变得更加艰辛——为了使用信息，它必须“再次将其分解”。

让我们更改一下：

public static List<string> FindLineAboveAsterisks(TextReader reader)

现在，它返回一个字符串集合，以便外界可以使用它。

考虑一下您想让该方法执行的操作：不要使调用代码复杂化——因为您将要调用它一次或多次，并且只编写一次。如果您使外部工作更加艰苦，那么您只是在添加每次使用该方法时必须做的工作。

因此，如果您需要一个项的集合，那么返回一个集合——不要来回移动，这样外部世界在每次调用您时都要做更多的处理！

但是...你为什么传递一个TextReader？这意味着每次您调用它时，外部世界都必须完成创建、打开、传递和关闭阅读器的工作——这很愚蠢。而是传递路径，然后让该方法使用它来做它想要做的事情：

public static List<string> FindLineAboveAsterisks(string filePath)

现在，调用看起来更容易使用。

同样，让自己的生活更轻松：您想读取文件吗？传递路径，让方法决定如何处理。如果传递TextReader或Stream，则将限制外部世界可以执行的操作，并在代码上强加“形状”，而这个“形状”对于它必须做的工作可能不是最简单或最有效的。

您设置的参数越“通用”，那么代码就可以变得更加灵活——这意味着它可以被重用——从而节省了您编写另一个相似的方法来执行相同操作的时间。

让我们开始填充该方法：我们需要返回一个List，并处理文件中的每一行。如果我们想使用每一行，那么让我们把它们全部拿来让系统处理吧！那很简单：

public static List<string> FindLineAboveAsterisks(string filePath)
    {
    List<string> lines = new List<string>();
    foreach (string line in File.ReadLines(filePath))
        {
        // ...
        }
    return lines;
    }

有什么可能更简单？我们知道必须做两件事：返回行集合，并处理文件中的所有行。因此，在方法顶部创建集合；最后返回。添加一个简单的循环，一次给我们每一行。结果：代码简单，易于编写。如果写起来很容易，它可能会起作用...

现在，我们与行有什么关系？

简单的; 我们需要收集下一行包含三个星号的所有行。

所以我们需要知道最后一行是什么。

想一想：在循环中，我们如何分辨下一行包含的内容？实际上，我们不能（除非我们使代码复杂化并使用不同的循环结构，但这很麻烦）。我们所知道的只是上一行的内容——因为我们已经处理了它，可以保留下一次副本。

因此，转过头去思考问题，将其视为“找到包含三个星号的所有行，并为每个行返回前一行”。片刻的思考告诉您得出相同的结果，这意味着我们可以使用已经查看过的“历史数据”来代替未使用过的“未来数据”。

让我们补充一点：

public static List<string> FindLineAboveAsterisks(string filePath)
    {
    List<string> lines = new List<string>();
    string lastLine = "";
    foreach (string line in File.ReadLines(filePath))
        {
        // ...
        lastLine = line;
        }
    return lines;
    }

每次，我们都添加少量的简单代码——没什么复杂的，所以出错的地方更少了。

我们需要检查当前行是否包含“***”。如果是这样，请将最后一个添加到集合中。这也很容易——快速if测试即可做到：

public static List<string> FindLineAboveAsterisks(string filePath)
    {
    List<string> lines = new List<string>();
    string lastLine = "";
    foreach (string line in File.ReadLines(filePath))
        {
        if (line.Contains("***"))
            {
            lines.Add(lastLine);
            }
        lastLine = line;
        }
    return lines;
    }

等等...完成了，不是吗？

我们现在要做的就是调用它并进行测试：

string path = @"D:\Test Data\List of hats.txt";
foreach (string line in FindLineAboveAsterisks(path))
    {
    Console.WriteLine(line);
    }

我可以向您显示原始代码……但您可能刚吃完饭……

那我们做了什么？

基本上，我们所做的只是完成一项完整的任务并将其分解为更小的任务：

引用：

编写一个读取文件并返回所有行的方法，该行之后是包含三个星号的行。

1. 确定需要返回什么
2. 确定需要什么作为参数
3. 创建可返回值，并设置我们返回它。
4. 添加一个循环以查看每一行。
5. 查看完之后，将当前行保存在循环的末尾，以备下次使用。
6. 检查该行是否带有星号。
7. 如果是这样，请将上次保存的行绕循环添加到输出集合中。

这些任务都不是难事：它们是一两行代码，它也是非常简单的代码。

这就是秘密：大任务由较小的任务组成，而较小的任务甚至由更小的任务组成。

您已经习惯了：每天都在使用它！

任务：“吃早餐”。

较小的任务：

1. 去厨房
2. 决定早餐吃什么。
3. 准备一下。
4. 吃了它。
5. 自己洗手。

这些任务中的每一个可能都非常复杂：

子任务：“去厨房”

1. 弄清楚你在哪里。
2. 弄清楚如何从这里到厨房。
3. 走到那

这些可能具有子-子-子任务：

子任务：“弄清楚你在哪里”

1. 醒来。
2. 睁开眼。
3. 环顾四周：我在哪里？我认得这个房间吗？昨晚我到底做了什么？
4. ...

概要

关键是，可以将每个任务分解成较小的部分，直到您完成可以执行的任务，或者知道如何找出要执行的任务。如果您在陌生的房间里醒来，则需要检查其他人，并可能问他们厨房在哪里——依此类推。

软件任务是相同的；将任务细化为较小的部分，某些——可能全部——可以很容易地完成，并逐步完成听起来更不可能的更大，更复杂的任务。

只是从思考而不是跳入代码开始：五分钟的计划可以节省您的工作时间！