Sfoglia il codice sorgente

feat: NDepend added to the main navigation

Vaclav Elias 1 anno fa
parent
commit
9ac9e6d911
3 ha cambiato i file con 15 aggiunte e 1 eliminazioni
  1. 12 0
      en/contributors/engine/ndepend.md
  2. 2 0
      en/contributors/toc.yml
  3. 1 1
      en/docfx.json

+ 12 - 0
en/contributors/engine/ndepend.md

@@ -0,0 +1,12 @@
+# [WIP] Introduction to NDepend
+
+[NDepend](https://www.ndepend.com/) is a powerful static analysis tool designed to provide comprehensive code quality insights, enforce coding standards, and identify potential flaws in software projects. In the context of the Stride game engine, NDepend helps maintain high code standards by analyzing dependencies, measuring code complexity, and offering detailed reports on various metrics.
+
+By integrating NDepend into our development process, we gain valuable insights that enable us to optimize the architecture, improve code performance, and ensure maintainability. The tool provides:
+
+- **Dependency Graphs and Matrix**: Visualize code organization and interdependencies within the engine.
+- **Code Metrics**: Quantitative measures of code complexity which assist in identifying areas that may require refactoring.
+- **Compliance to Coding Standards**: Ensures that the codebase adheres to defined coding standards, which is crucial for maintaining consistency and quality across the engine.
+- **Code Quality Gates**: Define specific criteria that the code must meet before being deemed production-ready, enhancing the overall quality of the game engine.
+
+For detailed insights generated by NDepend for the Stride game engine, visit our [NDepend Report](ndepend/NDependReport.html).

+ 2 - 0
en/contributors/toc.yml

@@ -36,6 +36,8 @@ items:
     href: engine/source-debugging.md
   - name: Visual Studio plugin
     href: engine/visual-studio-plugin.md
+  - name: Static analysis
+    href: engine/ndepend.md
   - name: 🏗️ Architecture
     expanded: true
     href: engine/architecture/index.md

+ 1 - 1
en/docfx.json

@@ -131,7 +131,7 @@
           "**/media/**/*.svg",
           "**/media/**/*.webp",
           "**/media/**/*.cs",
-          "contributors/NDependOut/**"
+          "contributors/engine/ndepend/**"
         ],
         "exclude": [ "_site/**", "obj/**" ]
       }