Skip to content

Commit e15c839

Browse files
committed
update readme
1 parent e87c414 commit e15c839

1 file changed

Lines changed: 0 additions & 28 deletions

File tree

README.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -178,31 +178,3 @@ And here's the generated overview figure:
178178
![](ExampleFigure.png)
179179

180180
The project-file based version of this example, as well as the [MakeFigure.py](SeeSharp.Examples/MakeFigure.py) script, can be found in the [SeeSharp.Examples](SeeSharp.Examples) directory.
181-
182-
## Coding conventions
183-
184-
The framework loosely follows the following coding conventions:
185-
186-
- Class names, method names, properties, and public fields are PascalCase
187-
- Private fields, parameters, and local variables are camelCase
188-
- Opening brackets are on the same line
189-
- Lines should be less than 110 characters long, for better readability and comparisons
190-
191-
The .editorconfig and omnisharp.json files configure some of these conventions for Visual Studio and VS Code, respectively.
192-
193-
Example:
194-
195-
```C#
196-
class SomeClass {
197-
public int PublicField = 1;
198-
public int PublicProperty => 13;
199-
public void ComputeSomething(byte complexParameterName, int anotherVeryLongParameterName,
200-
SomeClass mysteriousParameterThatIsNotNamedWell) {
201-
if (complexParameterName == PublicProperty) {
202-
int localName = 5;
203-
implementationDetail = $"SeeSharp {localName}";
204-
}
205-
}
206-
string implementationDetail;
207-
}
208-
```

0 commit comments

Comments
 (0)