add translations files for zh-CN
add zh-CN translations file - debug-instructions-windows.md add zh-CN translations file - debugging-instructions-macos.md update zh-CN translations file - README.md
This commit is contained in:
DemoPark
parent
529b84ff9c
commit
c78d7fc125
3 changed files with 145 additions and 2 deletions
|
|
@ -92,7 +92,7 @@
|
|||
* [构建步骤（macOS）](development/build-instructions-osx.md)
|
||||
* [构建步骤（Windows）](development/build-instructions-windows.md)
|
||||
* [构建步骤（Linux）](development/build-instructions-linux.md)
|
||||
* [调试步骤 (macOS)](development/debug-instructions-macos.md) 未翻译
|
||||
* [调试步骤 (Windows)](development/debug-instructions-windows.md) 未翻译
|
||||
* [调试步骤 (macOS)](development/debug-instructions-macos.md)
|
||||
* [调试步骤 (Windows)](development/debug-instructions-windows.md)
|
||||
* [在调试中使用 Symbol Server](development/setting-up-symbol-server.md)
|
||||
* [文档风格指南](styleguide.md)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,46 @@
|
|||
# 在 Windows 中调试
|
||||
|
||||
如果你在 Electron 中遇到问题或者引起崩溃，你认为它不是由你的JavaScript应用程序引起的，而是由 Electron 本身引起的。调试可能有点棘手，特别是对于不习惯 native/C++ 调试的开发人员。 然而，使用 Visual Studio，GitHub托管的 Electron Symbol Server 和Electron 源代码，在 Electron 的源代码中启用断点调试是相当容易的。
|
||||
|
||||
## 要求
|
||||
|
||||
* **Electron 的调试版本**: 最简单的方法是自己构建它，使用 [Windows 的构建说明](build-instructions-windows.md) 中列出的工具和先决条件要求。虽然你可以轻松地附加和调试 Electron，因为你可以直接下载它，你会发现，由于大量的优化，使调试实质上更加困难：调试器将无法向您显示所有变量的内容，并且执行路径可能看起来很奇怪，这是因为内联，尾部调用和其他编译器优化。
|
||||
|
||||
* **Visual Studio 与 C++ 工具**: Visual Studio 2013 和 Visual Studio 2015 的免费社区版本都可以使用。 安装之后, [配置 Visual Studio 使用 GitHub 的 Electron Symbol 服务器](setting-up-symbol-server.md). 它将使 Visual Studio 能够更好地理解 Electron 中发生的事情，从而更容易以人类可读的格式呈现变量。
|
||||
|
||||
* **ProcMon**: [免费的 SysInternals 工具][sys-internals] 允许您检查进程参数，文件句柄和注册表操作。
|
||||
|
||||
## 附加并调试 Electron
|
||||
|
||||
要启动调试会话，请打开 PowerShell/CMD 并执行 Electron 的调试版本，使用应用程序作为参数打开。
|
||||
|
||||
```powershell
|
||||
$ ./out/D/electron.exe ~/my-electron-app/
|
||||
```
|
||||
|
||||
### 设置断点
|
||||
|
||||
然后，打开 Visual Studio。 Electron 不是使用 Visual Studio 构建的，因此不包含项目文件 - 但是您可以打开源代码文件 "As File"，这意味着 Visual Studio 将自己打开它们。 您仍然可以设置断点 - Visual Studio 将自动确定源代码与附加过程中运行的代码相匹配，并相应地中断。
|
||||
|
||||
相关的代码文件可以在 `./atom/` 以及 Brightray 中找到, 找到 `./vendor/brightray/browser` 和 `./vendor/brightray/common`. 如果是内核，你也可以直接调试 Chromium，这显然在 `chromium_src` 中。
|
||||
|
||||
### 附加
|
||||
|
||||
您可以将 Visual Studio 调试器附加到本地或远程计算机上正在运行的进程。 进程运行后，单击 调试 / 附加 到进程（或按下 `CTRL+ALT+P`）打开“附加到进程”对话框。 您可以使用此功能调试在本地或远程计算机上运行的应用程序，同时调试多个进程。
|
||||
|
||||
如果Electron在不同的用户帐户下运行，请选中“显示所有用户的进程”复选框。 请注意，根据您的应用程序打开的浏览器窗口数量，您将看到多个进程。 典型的单窗口应用程序将导致 Visual Studio 向您提供两个 `Electron.exe` 条目 - 一个用于主进程，一个用于渲染器进程。 因为列表只给你的名字，目前没有可靠的方法来弄清楚哪个是。
|
||||
|
||||
### 我应该附加哪个进程?
|
||||
|
||||
在主进程内部执行的代码（即在主 JavaScript 文件中找到或最终运行的代码）以及使用远程代码调用的代码（`require('electron').remote`）将在主进程内运行，而其他代码将在其相应的渲染器进程内执行。
|
||||
|
||||
您可以在调试时附加到多个程序，但在任何时候只有一个程序在调试器中处于活动状态。 您可以在 `调试位置` 工具栏或 `进程窗口` 中设置活动程序。
|
||||
|
||||
## 使用 ProcMon 观察进程
|
||||
|
||||
虽然 Visual Studio 非常适合检查特定的代码路径，但 ProcMon 的优势在于它可以监视应用程序对操作系统的所有操作 - 捕获进程的文件，注册表，网络，进程和分析详细信息。 它试图记录发生的 **所有** 事件，并且可能是相当压倒性的，而且果你想了解你的应用程序对操作系统做什么和如何做，它则是一个很有价值的资源。
|
||||
|
||||
有关 ProcMon 的基本和高级调试功能的介绍，请查看Microsoft提供的[视频教程][procmon-instructions]。
|
||||
|
||||
[sys-internals]: https://technet.microsoft.com/en-us/sysinternals/processmonitor.aspx
|
||||
[procmon-instructions]: https://channel9.msdn.com/shows/defrag-tools/defrag-tools-4-process-monitor
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
# 在 macOS 中调试
|
||||
|
||||
如果你在 Electron 中遇到问题或者引起崩溃，你认为它不是由你的JavaScript应用程序引起的，而是由 Electron 本身引起的。调试可能有点棘手，特别是对于不习惯 native/C++ 调试的开发人员。 然而，使用 lldb 和 Electron 源代码，可以在 Electron 的源代码中使用断点启用逐步调试，这是相当容易的。
|
||||
|
||||
## 要求
|
||||
|
||||
* **Electron 的调试版本**: 最简单的方法是自己构建它，使用 [macOS 的构建说明](build-instructions-osx.md) 中列出的工具和先决条件要求。 虽然你可以轻松地附加和调试 Electron，因为你可以直接下载它，你会发现，由于大量的优化，使调试实质上更加困难：调试器将无法向您显示所有变量的内容，并且执行路径可能看起来很奇怪，这是因为内联，尾部调用和其他编译器优化。
|
||||
|
||||
* **Xcode**: 除了 Xcode，还安装 Xcode 命令行工具。它们包括 LLDB，在 Mac OS X 的 Xcode 中的默认调试器。它支持在桌面和iOS设备和模拟器上调试 C，Objective-C 和 C++。
|
||||
|
||||
## 附加并调试 Electron
|
||||
|
||||
要启动调试会话，打开命令行并启动 `lldb` ，并传递一个调试版本的 Electron 作为参数。
|
||||
|
||||
```bash
|
||||
$ lldb ./out/D/Electron.app
|
||||
(lldb) target create "./out/D/Electron.app"
|
||||
Current executable set to './out/D/Electron.app' (x86_64).
|
||||
```
|
||||
|
||||
### 设置断点
|
||||
|
||||
LLDB是一个强大的工具，支持进行多种策略的代码检查。 在这做一个基本的介绍，让我们假设你从 JavaScript 调用一个不正常的命令 - 所以你想打断该命令的 C++ 对应的 Electron 源。
|
||||
|
||||
相关的代码文件可以在 `./atom/` 以及 Brightray 中找到, 找到 `./vendor/brightray/browser` 和 `./vendor/brightray/common`. 如果是内核，你也可以直接调试 Chromium，这显然在 `chromium_src` 中。
|
||||
|
||||
让我们假设你想调试 `app.setName()`, 在 `browser.cc` 中定义为 `Browser::SetName()`. 使用 `breakpoint` 命令进行断点，指定文件和断点位置::
|
||||
|
||||
```bash
|
||||
(lldb) breakpoint set --file browser.cc --line 117
|
||||
Breakpoint 1: where = Electron Framework`atom::Browser::SetName(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&) + 20 at browser.cc:118, address = 0x000000000015fdb4
|
||||
```
|
||||
|
||||
然后, 启动 Electron:
|
||||
|
||||
```bash
|
||||
(lldb) run
|
||||
```
|
||||
|
||||
应用程式会立即暂停，因为 Electron 会在启动时设定应用程序名称:
|
||||
|
||||
```bash
|
||||
(lldb) run
|
||||
Process 25244 launched: '/Users/fr/Code/electron/out/D/Electron.app/Contents/MacOS/Electron' (x86_64)
|
||||
Process 25244 stopped
|
||||
* thread #1: tid = 0x839a4c, 0x0000000100162db4 Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 20 at browser.cc:118, queue = 'com.apple.main-thread', stop reason = breakpoint 1.1
|
||||
frame #0: 0x0000000100162db4 Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 20 at browser.cc:118
|
||||
115 }
|
||||
116
|
||||
117 void Browser::SetName(const std::string& name) {
|
||||
-> 118 name_override_ = name;
|
||||
119 }
|
||||
120
|
||||
121 int Browser::GetBadgeCount() {
|
||||
(lldb)
|
||||
```
|
||||
|
||||
显示当前帧的参数和局部变量, 运行 `frame variable` (或 `fr v`), 这将显示你的应用程序当前设置名称为 “Electron”.
|
||||
|
||||
|
||||
```bash
|
||||
(lldb) frame variable
|
||||
(atom::Browser *) this = 0x0000000108b14f20
|
||||
(const string &) name = "Electron": {
|
||||
[...]
|
||||
}
|
||||
```
|
||||
|
||||
在当前选择的线程中执行源级单步执行, 执行 `step` (或 `s`). 这将带你进入 `name_override_.empty()`。 继续前进，步过，运行 `next` (或 `n`).
|
||||
|
||||
```bash
|
||||
(lldb) step
|
||||
Process 25244 stopped
|
||||
* thread #1: tid = 0x839a4c, 0x0000000100162dcc Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 44 at browser.cc:119, queue = 'com.apple.main-thread', stop reason = step in
|
||||
frame #0: 0x0000000100162dcc Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 44 at browser.cc:119
|
||||
116
|
||||
117 void Browser::SetName(const std::string& name) {
|
||||
118 name_override_ = name;
|
||||
-> 119 }
|
||||
120
|
||||
121 int Browser::GetBadgeCount() {
|
||||
122 return badge_count_;
|
||||
```
|
||||
|
||||
要完成此时的调试，运行 `process continue`。 你也可以继续，直到这个线程中的某一行被命中（`线程直到100`）。 此命令将在当前帧中运行线程，直到它到达此帧中的行100，或者如果它离开当前帧，则停止。
|
||||
|
||||
现在，如果你打开 Electron 的开发工具并调用 `setName`，你将再次命中断点。
|
||||
|
||||
### 进一步阅读
|
||||
LLDB是一个强大的工具，有一个庞大的文档。 要了解更多信息，请参考 Apple 的调试文档, 例如 [LLDB Command Structure Reference][lldb-command-structure]
|
||||
或 [Using LLDB as a Standalone Debugger][lldb-standalone].
|
||||
|
||||
你也可以查看LLDB的 [manual and tutorial][lldb-tutorial], 这将解释更复杂的调试场景.
|
||||
|
||||
[lldb-command-structure]: https://developer.apple.com/library/mac/documentation/IDEs/Conceptual/gdb_to_lldb_transition_guide/document/lldb-basics.html#//apple_ref/doc/uid/TP40012917-CH2-SW2
|
||||
[lldb-standalone]: https://developer.apple.com/library/mac/documentation/IDEs/Conceptual/gdb_to_lldb_transition_guide/document/lldb-terminal-workflow-tutorial.html
|
||||
[lldb-tutorial]: http://lldb.llvm.org/tutorial.html
|
||||
Loading…
Reference in a new issue