|
Useful if the comments keep up with code changes, but too often I have seen code changed and the comments left untouched, even ignored in code reviews. Result is worse than no comments at all!
|
|
|
|
|
True, it takes some discipline to update the comments which is something some developers seem to lack ...
|
|
|
|
|
We use DoxyPress[^], a ground-up rewrite of doxygen. We switched to it when we discovered doxygen couldn't handle our code base.
They use specially-marked comments in the source code to generate documentation. The comments can use Markdown for formatting. It can generate HTML, HTML Help, LaTex, etc. It's pretty capable. Out of the box it can generate documentation from unmarked code that's useful in and of itself including outlines of the source code, a class index, call and inheritance graphs and so on. It handles C# well, unlike doxygen.
We've begun documenting our current generation product using it. Our automated build process runs DoxyPress against the code, generating source documentation for each build.
Software Zen: delete this;
|
|
|
|
|
will have to look into this. I used to use a product from SciTools, but they got stupid expensive. Guess they decided the small developer market was irrelevant. I don't have a problem paying $1200 for a product. Forcing me to do it every dang year? I don't think so.
Charlie Gilley
“They who can give up essential liberty to obtain a little temporary safety deserve neither liberty nor safety.” BF, 1759
Has never been more appropriate.
|
|
|
|
|
I write all my documentation from scratch using HelpSmith.
For me, it is the only way to get concise documentation for my applications...
Steve Naidamast
Sr. Software Engineer
Black Falcon Software, Inc.
blackfalconsoftware@outlook.com
|
|
|
|
|
It really comes down to an organization that wants to enforce it's will on developers to document their $$$t. The vast majority of code is butt simple, but their are times when you are writing a nuclear detonation simulation .... that sort of arcane classified stuff that should be doc'd.
Having said that, the most important part of s/w doc is the why. This is typically driven by users - we call this tribal knowledge. In my 40+ years, I have NEVER seen any management thought to this area. There are reasons the code does what it does. It's at the business or user level. Two examples:
1) 20 years ago, I started my HMI machine development efforts. We had a rule - touch screen buttons must be at least 25mm square on the screen. Why? Well, my products worked on hot melt glue applications, so most of the time the operators had gloves on. Never documented. Walks around in people's heads. 20 years later, safety no longer allows operators near the machines. So, we're off to remote touchscreens and smart phone interfaces. Not documented.
2) Working with gluing systems. Back in the early days of this one product, we had the need to do something as a maintenance operation. The first version was coded up as an on/off driven by the touchscreen. Well, the touchscreen turned it on and then for reasons I have long forgot crashed. Leaving the unit on... making a puddle of stuff on the factory floor while the people there waited for the the touchscreen to reboot. So, we changed the process as on of "keep doing that" every second from the touchscreen. Auto shutoff in the event of a touchscreen crash. documented? nope.
It's not about the code - it's the system.
Charlie Gilley
“They who can give up essential liberty to obtain a little temporary safety deserve neither liberty nor safety.” BF, 1759
Has never been more appropriate.
|
|
|
|
|
It's mostly due to the if 'what do we do if your are hit by a bus', my answer 'what is this 'Bus' you speak of?, the acients tell tales of them!' For most of them I have stuck a circuit diagram and the flowchart of operation and where need the embedded code (C mostly, little bit of assembly) with a flowchart. I think a flow chart for the Windows code is not really do-able, I'm using a Class and a DLL I can't, don't want to get into! 
|
|
|
|
|
... how enjoyable desktop app development is.
I've spent the last couple of weekends implementing a WPF version of our web app as a POC. There is no hope in hell of this code actually going anywhere, but I can exercise various aspects of our web app.
I've got the following stuff implemented:
0) The user can use Ctrl+/Ctrl- to grow/shrink the app's font (like a web browser) for Section 508 compliance
1) Most of the forms in the app have a listview, so I'm using my AutomaticListView component ()[^]), and have derived a ne version that automatically increases column widths to keep up with the MainWindow's font size increase/decrease.
2) I'm using my Customizable WPF MessageBox[^], with changes that include extended icons, and border colors that are aligned with the icons (green=success, blue=info, etc). This kind of mimics your typical web-based message indicators.
3) The app acts like an old-school SDI app, with each form being a UserControl and the app managing display/disposal
4) The base form class provides support for app-specific function keys, as well as the ability to augment these function keys on a form-by-form basis with pre/post event handlers, as well as the ability to override the common functionality of the function key itself.
5) We have a weird date control in the web app with "peculiar" behavior, and I've been able to succesfully duplicate it in the form of a custom control. It includes a lot of fail-gracefully code, as well as a tooltip that includes error info in the event the user does something stupid. (We don't present a calendar on our date controls because the web app has to support complete keyboard-driven input.
Overall, it's been a blast working on the desktop again. I sure miss the old days... The last time I did a desktop app for a paycheck was 2015...
".45 ACP - because shooting twice is just silly" - JSOP, 2010
-----
You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
-----
When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013
|
|
|
|
|
#realJSOP wrote: has to support complete keyboard-driven input
So it is still a gov't oriented project. They're the main ones that look for that "operators will be reading forms and entering data so make it such that they don't have to look at the screen much." motif.
I’ve given up trying to be calm. However, I am open to feeling slightly less agitated.
I’m begging you for the benefit of everyone, don’t be STUPID.
|
|
|
|
|
Any data entry system should support keyboard field movement. It doesn't matter if it's a desktop or web application.
|
|
|
|
|
Should and DOES are two different things.
I’ve given up trying to be calm. However, I am open to feeling slightly less agitated.
I’m begging you for the benefit of everyone, don’t be STUPID.
|
|
|
|
|
It's a forensic drug testing application, and the folks in the labs use barcode scanners and keyboard input. They rarely (if ever) need to use a mouse for anything other than selecting the form they want to use.
I think this app is the most complex I've ever worked on, even more so than the tax/charitable giving software I used to do...
The complexity isn't a problem - the fact that it's a web app is what I have issues with.
".45 ACP - because shooting twice is just silly" - JSOP, 2010
-----
You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
-----
When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013
|
|
|
|
|
#realJSOP wrote: Forum:The Lounge
... how enjoyable desktop app development is.
My current ratio of desktop/web development is about 50/50 trending toward more web development. IMHO desktop is just easier/quicker for a POC for a lot of reasons...no back button, session state, richer controls are a few that come to mind.
I can't say I prefer one or the other, but for a POC or testing, it sure is quicker to design/test/debug a desktop app. I can't tell you how many minutes a day I wait for the VS IIS Express to spin up just to test a minor edit  ...enough that I got a bigger hammer (new system with more of everything) waiting in the wings.  Another weekend and I'll make the move.
"Go forth into the source" - Neal Morse
"Hope is contagious"
|
|
|
|
|
Wordle 1,010 4/6
⬜🟩⬜🟨⬜
🟩🟩⬜⬜🟩
🟩🟩🟩⬜🟩
🟩🟩🟩🟩🟩
|
|
|
|
|
Wordle 1,010 4/6
🟨⬜⬜⬜⬜
⬜🟩🟨⬜⬜
🟩🟩🟩⬜🟩
🟩🟩🟩🟩🟩
Isn't this a proper noun?
|
|
|
|
|
It has another meaning - which I can't refer to without making it a spoiler! 
"I have no idea what I did, but I'm taking full credit for it." - ThisOldTony
"Common sense is so rare these days, it should be classified as a super power" - Random T-shirt
AntiTwitter: @DalekDave is now a follower!
|
|
|
|
|
Wordle 1,010 3/6
🟩⬛⬛⬛⬛
🟩🟩⬛🟩🟩
🟩🟩🟩🟩🟩
|
|
|
|
|
Wordle 1,010 3/6*
🟩🟨🟨⬜⬜
🟩⬜🟩🟨🟩
🟩🟩🟩🟩🟩
Happiness will never come to those who fail to appreciate what they already have. -Anon
And those who were seen dancing were thought to be insane by those who could not hear the music. -Frederick Nietzsche
|
|
|
|
|
Wordle 1,010 3/6*
🟨⬜⬜🟨⬜
🟩🟩🟩⬜🟩
🟩🟩🟩🟩🟩
"I have no idea what I did, but I'm taking full credit for it." - ThisOldTony
"Common sense is so rare these days, it should be classified as a super power" - Random T-shirt
AntiTwitter: @DalekDave is now a follower!
|
|
|
|
|
⬜⬜🟨⬜⬜
⬜⬜⬜⬜🟨
🟩🟩🟩⬜⬜
🟩🟩🟩🟩🟩
In a closed society where everybody's guilty, the only crime is getting caught. In a world of thieves, the only final sin is stupidity. - Hunter S Thompson - RIP
|
|
|
|
|
Wordle 1,010 5/6
⬜⬜⬜⬜🟨
⬜⬜⬜⬜⬜
⬜🟨🟨⬜🟩
🟩🟩🟩⬜🟩
🟩🟩🟩🟩🟩
I knew this is a name, but never heard this used as a word 
|
|
|
|
|
Wordle 1010 5/6
⬛⬛⬛⬛⬛
⬛⬛🟨⬛⬛
⬛🟩🟩⬛⬛
⬛🟩🟩🟩🟩
🟩🟩🟩🟩🟩
Rules for the FOSW ![ ^]
MessageBox.Show(!string.IsNullOrWhiteSpace(_signature)
? $"This is my signature:{Environment.NewLine}{_signature}": "404-Signature not found");
|
|
|
|
|
Wordle 1,010 X/6
🟨🟨⬛⬛⬛
⬛🟩🟩🟩🟩
⬛🟩🟩🟩🟩
⬛🟩🟩🟩🟩
⬛🟩🟩🟩🟩
⬛🟩🟩🟩🟩
Stoopid word!
Ok, I have had my coffee, so you can all come out now!
|
|
|
|
|
Wordle 1,010 X/6*
🟨⬛⬛⬛⬛
🟩⬛🟨⬛⬛
🟩🟩⬛⬛🟩
🟩🟩⬛⬛🟩
🟩🟩⬛⬛🟩
🟩🟩⬛⬛🟩
|
|
|
|
|
today when i tried to use firefox with my default page set to be https://ighome
it takes one to a block by Norton
BLOCKED BY
Malicious Website Blocked
You attempted to access
https://militantwitnessfelon.com/15874427e93bdcd82b28ba6919bed2ec/invoke.js
This webpage is a known malicious webpage. It is highly recommended that you do NOT visit this page.
it might be just be my problem or error. It seems to effect both my desktops which are not directly connected to each other. Work in progress.
"A little time, a little trouble, your better day"
Badfinger
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
