Comments (6)
Absolutely.
from devilution.
Eventually, but not a priority. I've tried to only add comments where there are decompiler errors, to help make them easier to spot. I'd prefer to keep it this way for awhile so self-explanatory functions don't get clogged. E.g.
if( leveltype == LT_CAVES ) // if the level type is in the caves
{
if( player == myplr ) // if the current player is my player
{
CastSpell(SPELL_TOWNPORTAL); // cast town portal
PlaySFX(SOUND_PORTAL); // play town portal sound
from devilution.
As this is C++ and not C# I would still stick to Dennis Doomens Guidlines for commenting code AV2310 & AV2316
https://csharpcodingguidelines.com/documentation-guidelines/
from devilution.
I would like to see comments on address spaces in the original exe . this will make it easier for me when I say need to look at the original function in asm.
from devilution.
I would like to see comments on address spaces in the original exe . this will make it easier for me when I say need to look at the original function in asm.
This was part of the original source (as taken from the decompiler), but was removed in rev 49a6f4f and superseded by Support/surgery.xls.
I wouldn't mind if these addresses were added again to the source code to facilitate reversing. Later when we hit 1.0 they can be removed. What do you think @galaxyhaxz?
from devilution.
Yeah it might be a good idea to add those back at least to the .h
files. We'll add comments later on as everything is gradually cleaned up.
from devilution.
Related Issues (20)
- [hellfire] Hive/Crypt - invisible chests and barrels HOT 1
- Are you able to use Hellfire's source code? HOT 1
- [hellfire] OperateL2Door - Please check bin exactness HOT 10
- Building in VS2019: exe attempts to open crypto/rsa key file? HOT 1
- Cleanup code HOT 1
- out of memory error HOT 5
- 60 FPS support? HOT 1
- Migrate macOS builds to GitHub Actions HOT 10
- [Not A Bug] Question about the License and Legal Section in the Readme HOT 5
- MaxGold always depends on auricGold HOT 4
- Gnat String's "Multiple arrows per shot" only fires one arrow HOT 2
- Win98 Support? HOT 1
- Farmer Quest Bug HOT 1
- [Feature request] add option to show items on map HOT 4
- [Android] Option to change stationary toggle to allow moving
- "Legal" section ambiguity HOT 1
- [MSVC][permissive-] devilution failed to build with /permissive- on MSVC HOT 5
- [Need help] Getting a Massive bow of swiftness at clvl 44+ HOT 3
- Is this gap intentional? HOT 1
- mods don't work In the mobile application HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from devilution.