编程中的代码规范、项目创建与问题解决

### 编程中的代码规范、项目创建与问题解决 #### 1. 代码间距与可读性 编译器通常不关心代码中的间距，只要不在单词内部添加空格，你可以随意放置空格，也可以自由选择是否换行，只要不破坏注释（`//`）或引号（`"`）即可。例如下面这个示例： ```cpp //Hello, world! program, for _C++ for Lazy Programmers_ //It prints "Hello, world!" on the screen. //Quite an accomplishment, huh? // -- from _C++ for Lazy Programmers_ #include "SSDL.h" int main (int argc, char** argv) { sout << "Hello, world! (Press any key to quit.)\n"; SSDL_WaitKey (); //Wait for user to hit any key return 0; } ``` 虽然编译器不在意这样的间距，但对于后续维护代码的人来说，这样的代码会是一场噩梦。代码的可读性非常重要，因为日后试图理解你代码意图的可能就是你自己。软件开发中大部分的成本在于程序员的时间，所以你肯定不想浪费时间去解读自己写的代码。 为了提高代码的可读性，有以下几个建议： - **使用空行分隔**：就像写英语论文时划分段落一样，用空行分隔初始注释、`#include` 和 `main()` 等部分，每个部分就像是一个独立的“段落”。 - **合理换行**：在合理的位置换行，让代码更易于阅读。 - **正确缩进**：默认缩进为左边界，如果某个语句包含在其他语句中，比如 `sout` 语句包含在 `main` 程序中，就应该缩进一个制表符或几个空格。这类似于论文的大纲格式或目录的布局。 **间距的黄金法则**：当某个内容是前面内容的一部分时，应该进行缩进；当它是独立的内容时，保持相同的缩进级别。 #### 2. 创建SSDL项目（在Visual Studio中） 创建SSDL项目的最简单方法如下： 1. **复制项目文件夹**：复制一个可用的项目文件夹，源代码中有一个名为 `basicSSDLProject` 的文件夹，它知道在源代码中何处找到SDL和SSDL，所以要将复制的文件夹放在相同的位置。 2. **重命名文件夹**：将复制的文件夹重命名为合适的名称，例如 `hello`。 3. **打开解决方案文件**：打开其解决方案（`.sln`）文件。 如果你想从头开始创建项目，可以查看源代码中的说明。另外，第一次启动Visual Studio时，它可能会询问你想要的默认环境，选择C++即可。设置配置文件可能需要一些时间，但这是一次性的操作，之后就无需等待了。如果设置有误，可以通过 `Tools ➤ Import and Export Settings ➤ Reset all settings` 进行重置。 #### 3. 编译和运行程序 在编写程序之前，你需要为程序添加一些内容，例如可以输入示例1 - 1中的“Hello, world!”程序。在输入过程中可能会出现拼写错误，编辑器可能会通过在错误部分下方显示红色波浪线来警告你，将鼠标指针悬停在该部分上，它会给出错误提示，但提示可能并不总是清晰的。 要编译程序，可以选择 `Build ➤ Build Solution`；要运行程序，可以选择 `Debug ➤ Start without debugging`，也可以点击窗口顶部附近的绿色箭头或三角形。 如果程序编译失败，它会给出错误列表。有时错误信息很容易理解，有时则不然。例如，忘记添加分号或拼写错误可能会导致以下错误： ```plaintext c:\...\main.cpp(13): error C2146: syntax error: missing ';' before identifier 'SDL_WaitKey' c:\...\main.cpp(13): error C3861: 'SDL_WaitKey': identifier not found ``` 随着经验的积累，你会逐渐理解这些晦涩的错误信息。目前，可以将你输入的程序与示例1 - 1进行比较，修复所有差异，直到程序成功运行。程序运行时，按任意键即可结束。 #### 4. 项目文件相关 在项目文件夹中，有一些重要的文件： | 文件名称 | 说明 | | ---- | ---- | | `hello.sln` | “解决方案”文件，它知道其他文件的位置。 | | `hello.vcxproj` | “项目”文件，它知道程序存储在 `main.cpp` 中以及其他一些信息，没有它就无法编译程序。 | | `main.cpp` | 你的程序代码。 | | `Debug`（或 `x64`）文件夹 | 包含可执行文件。 | 如果你需要节省空间，可以删除 `Debug`、`.vs` 和 `x64` 文件夹，以及 `.sdf` 或 `.ncb` 文件（如果有的话），Visual Studio会根据需要重新创建它们。 要重新打开项目，可以双击 `hello.sln` 文件来启动Visual Studio并重新打开你正在处理的项目，也可以通过菜单 `File ➤ Open ➤ Project/Solution` 打开。 #### 5. 常见问题及解决方法（Visual Studio） 在使用Visual Studio时，可能会遇到以下常见问题及解决方法： - **需要登录Microsoft账户**：如果你很着急，可以选择“Not now, maybe later”。 - **无法打开包含文件或 `.lib` 文件**：错误信息可能会显示类似 `fatal error C1083: Cannot open include file: 'SSDL.h': No such file or directory` 或 `1>LINK : fatal error LNK1104: cannot open file 'sdl2_ttf.lib'` 的内容。最可能的原因是项目文件夹在源代码仓库中的位置不正确，确保它与 `basicSSDLProject` 文件夹在相同的位置。如果你选择了不同的设置，要确保 `Additional Include Directories` 和 `Additional Library Directories` 包含指向SDL和SSDL的包含文件和库文件夹的有效路径。 - **编辑后无法编译或编辑无效**：可能是因为你没有打开 `.sln` 文件，而是打开了 `main.cpp` 或其他文件。Visual Studio需要 `.sln` 文件，关闭当前正在处理的文件（保存编辑内容），然后双击 `.sln` 文件重新打开。 - **编辑器未正确识别关键字**：你输入的内容编辑器没有按预期着色，或者在下面显示红色波浪线。可能是有拼写错误，或者编辑器出现了混淆，重新编译以确认。 - **无法打开 `.exe` 文件进行写入**：可能是程序仍在运行，无法覆盖正在使用的程序。关闭程序后再试。 - **出现其他错误信息且无法完成构建**：通常再次尝试就可以解决问题。 - **程序运行时间过长**：可以耐心等待，或者通过Windows任务管理器终止程序。如果这种情况经常发生，很可能是程序存在问题。 - **出现关于Windows SDK的错误**：可以右键单击项目（不是解决方案或 `main.cpp`），选择 `Retarget Projects`，并同意相关设置。 #### 6. 使用g++创建项目 g++ 是一个免费的开源编译器，当有人说“真正的程序员使用Unix”时，使用g++你就不用感到心虚了。但它没有自己的环境或编辑器，在Unix系统上，你可以使用 `vi/vim`、`emacs` 或其他编辑器。如果你通过窗口环境进行操作，开始可能会相对轻松；如果不是，可以在网上查找相关说明。 创建项目时，最简单的方法是复制源代码仓库中的 `basicSSDLProject` 文件夹作为新项目（可以使用 `cp -R` 命令），并按照 `README.txt` 中的说明进行操作。 #### 7. g++项目中的文件 在新文件夹中，在命令提示符下输入 `ls` 或 `dir`，你会看到一些文件，可能包括 `a.out`、`main.cpp`、`main.cpp~`、`main.o` 等。 - `a.out`：可执行程序。 - `main.cpp`：你编写的代码。 - `main.cpp~`：编辑器可能创建的 `.cpp` 文件的备份。 - `main.o`：g++ 在创建程序过程中可能生成的“对象”文件，如果看到它，可以安全地删除（使用 `rm main.o` 命令）。 要删除所有不需要的文件，可以输入 `make clean` 命令。 #### 8. 酷的命令行技巧 - **重复命令**：在命令提示符下，通常可以按向上箭头重复上一个命令，多次按可以重复更早的命令。如果不行，可以使用 `!` 后跟命令的前几个字母来重复该命令的最后一次实例。 - **代码格式转换**：可以使用在线转换器，或者如果安装了相关工具，可以使用 `dos2unix < windowsfile.txt > unixfile` 命令将Windows格式的代码转换为Unix格式，使用 `unix2dos` 命令进行反向转换。 #### 9. 压缩文件（Unix） 如果你想将目录压缩成一个文件以便邮寄或存储，可以在删除不需要的大文件（使用 `make clean` 命令）后，进入上一级目录（使用 `cd ..` 命令），然后使用以下命令进行压缩： ```plaintext tar -czvf project1.tar.gz project1 ``` 要解压文件，将其放在你想要的位置（确保该位置没有已经存在的 `project1` 目录，以防止覆盖），然后使用以下命令： ```plaintext tar -xzvf project1.tar.gz ``` 不同的Unix安装可能需要稍微修改命令，但在很多机器上上述命令都可以正常工作。 #### 10. g++项目中的常见问题及解决方法 - **程序无法停止**：程序可能在等待输入（如按某个键继续），或者陷入了无限循环。可以使用 `Ctrl - C` 组合键终止程序。 - **出现“Segmentation fault: core dumped”错误**：这意味着“发生了不好的事情”。目前，只需删除核心文件（使用 `rm core` 命令），然后在程序中查找问题。 #### 11. 避免编程痛苦的方法 无论使用哪种编译器，都可能遇到以下问题： - **出现大量错误**：这并不意味着你犯了无数个错误，有时一个错误可能会让编译器非常困惑，以至于它认为后续的所有内容都是错误的。因此，明智的做法是先修复第一个错误，它可能会消除后续的大量错误信息。 - **错误所在行看起来正常**：问题可能出在前一行，编译器直到下一行才发现问题，所以错误报告的位置可能比你预期的要晚，这种情况在缺少分号时经常发生。 - **程序有警告但仍可运行**：编译器给出警告时仍然可以生成程序，但错误会阻止编译。你可以忽略警告，但它们通常是需要修复问题的良好提示。 - **每个程序一开始都充满错误**：不要怀疑自己的能力，大家都会遇到这种情况。即使是简单的“Hello, world!”程序可能第一次就能正常运行，但稍微复杂一点的程序就很难保证了。 - **程序突然无法工作**：当你进行了重大更改（重大意味着你担心无法撤销）后，程序可能会出现问题。为了避免这种情况，建议在进行重大更改时创建备份： - **Windows**：复制包含项目的文件夹（包括 `.sln`、`.vcxproj` 和 `.cpp` 文件等）。 - **Unix**：复制 `.cpp` 文件，例如使用 `cp main.cpp main.cpp.copy1` 命令，也可以复制整个目录（使用 `cp -R` 命令）。 **不抓狂的黄金法则**：在编辑程序时，要经常创建备份副本。 ### 编程中的代码规范、项目创建与问题解决 #### 12. 代码可读性与规范的重要性总结 代码的可读性和规范对于编程工作至关重要。从前面的内容我们可以看到，良好的代码规范不仅能让后续维护者轻松理解代码，更能在软件开发过程中节省大量的时间和精力。合理的间距、正确的缩进和空行的使用，就像给代码穿上了一件整洁的外衣，让代码结构一目了然。以下是代码可读性和规范的重要性总结表格： | 重要性方面 | 说明 | | ---- | ---- | | 维护性 | 便于后续维护者理解代码逻辑，减少维护成本。 | | 自我理解 | 日后自己阅读代码时能快速明白意图，避免浪费时间解读。 | | 团队协作 | 在团队开发中，统一的代码规范有助于成员之间的交流和合作。 | #### 13. 项目创建流程对比 我们介绍了在Visual Studio和使用g++两种方式创建SSDL项目的流程，下面通过一个mermaid流程图来对比这两种方式： ```mermaid graph LR classDef startend fill:#F5EBFF,stroke:#BE8FED,stroke-width:2px; classDef process fill:#E5F6FF,stroke:#73A6FF,stroke-width:2px; classDef decision fill:#FFF6CC,stroke:#FFBC52,stroke-width:2px; A([开始]):::startend --> B{选择开发环境}:::decision B -->|Visual Studio| C(复制项目文件夹):::process B -->|g++| D(复制basicSSDLProject文件夹):::process C --> E(重命名文件夹):::process E --> F(打开.sln文件):::process D --> G(按README.txt操作):::process F --> H(编写代码):::process G --> H H --> I(编译运行):::process I --> J([结束]):::startend ``` 从流程图可以清晰地看到，两种方式在前期的项目创建步骤有所不同，但最终都要进行代码编写、编译和运行。 #### 14. 编译与运行流程梳理 编译和运行程序是编程过程中的关键环节，无论是在Visual Studio还是使用g++，都有相应的操作步骤。下面是编译和运行流程的梳理： - **Visual Studio**： 1. 编写代码，如输入“Hello, world!”程序。 2. 检查代码，编辑器可能会提示拼写错误等问题。 3. 编译程序：选择 `Build ➤ Build Solution` 或点击绿色箭头。 4. 运行程序：选择 `Debug ➤ Start without debugging` 或点击绿色箭头。 - **g++**： 1. 编写代码，保存为 `.cpp` 文件。 2. 在命令行使用 `g++` 命令进行编译，如 `g++ main.cpp -o output`。 3. 运行生成的可执行文件，如 `./output`。 #### 15. 文件管理总结 项目中的文件管理也非常重要，不同的文件有不同的作用，合理管理文件可以提高开发效率和节省空间。以下是文件管理的总结： | 文件类型 | 作用 | 管理建议 | | ---- | ---- | ---- | | `.sln` | 解决方案文件，记录项目文件位置 | 重新打开项目时使用 | | `.vcxproj` | 项目文件，包含编译信息 | 编译程序必需 | | `.cpp` | 程序代码文件 | 编写和修改程序的主要文件 | | `Debug`/`x64` 文件夹 | 包含可执行文件 | 空间不足时可删除，会重新生成 | | `.sdf`/`.ncb` 文件 | 辅助文件 | 可删除，会重新生成 | | `a.out` | g++ 生成的可执行文件 | 运行程序的文件 | | `main.cpp~` | 备份文件 | 可根据需要保留或删除 | | `main.o` | 对象文件 | 可删除 | #### 16. 常见问题解决流程 在编程过程中，遇到问题是不可避免的，关键是要知道如何解决这些问题。下面通过一个mermaid流程图来展示常见问题的解决流程： ```mermaid graph LR classDef startend fill:#F5EBFF,stroke:#BE8FED,stroke-width:2px; classDef process fill:#E5F6FF,stroke:#73A6FF,stroke-width:2px; classDef decision fill:#FFF6CC,stroke:#FFBC52,stroke-width:2px; A([遇到问题]):::startend --> B{问题类型}:::decision B -->|登录问题| C(选择Not now, maybe later):::process B -->|文件打开问题| D(检查项目文件夹位置):::process B -->|编译问题| E(检查代码拼写和语法):::process B -->|运行问题| F(终止程序或检查输入):::process C --> G(继续操作):::process D --> H(调整路径或重新打开.sln):::process E --> I(修复错误后重新编译):::process F --> J(解决问题后重新运行):::process G --> K([问题解决]):::startend H --> K I --> K J --> K ``` 从流程图可以看到，不同类型的问题有不同的解决方法，按照流程逐步排查和解决问题，可以提高解决问题的效率。 #### 17. 备份的重要性强调 备份是编程过程中容易被忽视但又非常重要的环节。在进行重大更改时，创建备份可以避免因错误操作导致的程序无法运行或数据丢失。以下是备份的重要性总结： - **防止错误无法恢复**：当程序出现问题时，可以恢复到之前正常的版本。 - **减少重复工作**：避免因错误而重新编写大量代码，节省时间和精力。 - **增加信心**：在进行大胆的修改时，有备份作为保障，会更加有信心。 建议在每次进行重大更改前都创建备份，养成良好的备份习惯。 #### 18. 总结与展望 编程是一个不断学习和实践的过程，在这个过程中，我们会遇到各种各样的问题，但只要掌握了正确的方法和技巧，就能轻松应对。通过本文，我们了解了代码规范、项目创建、编译运行、文件管理、问题解决和备份等方面的知识，希望这些知识能帮助你在编程的道路上更加顺利。 未来，随着技术的不断发展，编程工具和方法也会不断更新和改进。我们需要保持学习的热情，不断探索新的技术和方法，提高自己的编程水平。同时，也要注重代码的质量和可读性，为自己和他人创造更好的编程体验。