lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-05-10 09:30:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Coding - Standardize comment separators, translate French comments (#1126)

Browse Source 
Normalize method separator lines across the codebase to exactly
100 characters (// followed by 98 = signs) matching the project
coding standard.

Translate remaining French comments to English in ModelingData
packages (TKBRep, TKG2d, TKG3d, TKGeomBase) and FoundationClasses.

Add [[nodiscard]] attribute to Copy() methods on Geom_Geometry,
Geom2d_Geometry, Geom_Transformation, and Geom2d_Transformation
to prevent accidental discard of returned handles.

Fix typo in AppDef_Variational::Dump() debug output: "Nombre of
3d par multipoint" -> "Number of 3d per multipoint".

Update .github/copilot-instructions.md separator examples to match
the corrected convention.
This commit is contained in:
Pasukhin Dmitry
2026-02-27 12:34:21 +00:00
committed by GitHub
parent d7abd72eac
commit 2ce7b26ddb
366 changed files with 3945 additions and 4583 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/copilot-instructions.md vendored
View File

@@ -367,14 +367,14 @@ Each method **MUST** be preceded by:
2. An empty line after the separator
```cpp
//==================================================================================================
//=================================================================================================
void MyClass::MyMethod(const TopoDS_Shape& theShape)
{
// Implementation
}
//==================================================================================================
//=================================================================================================
bool MyClass::AnotherMethod()
{
@@ -385,10 +385,10 @@ bool MyClass::AnotherMethod()
**DO NOT use old-style function guards:**
```cpp
// WRONG - Do not use this style:
//==================================================================================================
//=================================================================================================
// purpose: Description of what the method does
// function: MyClass::MyMethod
//==================================================================================================
//=================================================================================================
```
### Technical Comments
@@ -398,7 +398,7 @@ Place implementation notes inside the method body:
- Inline where specific logic needs explanation
```cpp
//==================================================================================================
//=================================================================================================
void MyClass::ComplexMethod(const TopoDS_Shape& theShape)
{