Refactor/graphic/file naming snake case - #78
Merged
CoraBlack merged 4 commits intoAug 13, 2026
Merged
Conversation
Convert math module's line-leading /// comments to / ** * / blocks, normalize graphic module's comment block indentation (star aligned one column right of the opening /**), and fix stray /// comments to blocks. No code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR: refactor(graphic): 文件名统一 snake_case + 注释统一 Doxygen 块风格
描述
概述
落地 CLAUDE.md 中约定的代码格式规范,包含两大部分:
snake_case(Renderer.hpp → renderer.hpp等),并同步更新gkit.hpp、CMake 与引用处的 include。/** */Doxygen 块风格:math 模块约 540 处行首///注释转换为/** @brief ... */块;graphic 模块清理零星///,并把块注释内部的 tab 缩进归一化为空格(星号与/**的中间*对齐)。另外新增
.gitignore规则,忽略本地文档CLAUDE.md与docs/(不随仓库提交)。改动内容
1. 文件重命名 snake_case(
include/gkit/graphic/、src/graphic/,共 39 个文件)render/:Renderer.hpp/cpp、RenderDevice.hpp、RenderObject.hpp/cpp、RenderQueue.hpp/cpp、RenderCommand.hpp、RenderState.hppresource/:Buffer.hpp、FrameBuffer.hpp/cpp、IndexBuffer.hpp/cpp、Material.hpp、RenderBuffer.hpp/cpp、Shader.hpp/cpp、StorageBuffer.hpp、Texture.hpp/cpp、UniformBuffer.hpp、VertexArray.hpp/cpp、VertexBuffer.hpp/cpp、VertexBufferLayout.hppbackend/opengl/:Device.hpp/cpp、StateManager.hpp/cpp等 17 个文件gkit.hpp、src/graphic/CMakeLists.txt、src/graphic/create_device.cpp、test/graphic/test_render.cpp2. 注释统一为 Doxygen 块风格(
include/gkit/math/8 个 +include/gkit/graphic/、src/graphic/27 个)math:
color.hpp、constants.hpp、matrix3/4.hpp、scalar.hpp、vector2/3/4.hpp中约 540 处///转换为/** @brief ... */块;6 处行尾; /// @brief后置注释改为块上注释。graphic:清理零星
///,块注释内 tab 缩进统一为空格,对齐格式如下:3. .gitignore(
.gitignore)# local documentation (untracked)段:忽略CLAUDE.md与docs/。测试
gkit_graphic+test_render)。///;全部 414 个注释块星号对齐(*列 =/**缩进 + 1),0 个错位。Commits
0b0ed4111289e6ff626a1验证
cmake --preset x86_64-gcc-debug+cmake --build build/x86_64-gcc-debug构建通过。git diff复核:graphic 改动仅含注释行,无代码变更混入。test_log挂起/崩溃、test_value退出码 1。