473,473 Members | 2,274 Online
Bytes | Software Development & Data Engineering Community
Create Post

Home Posts Topics Members FAQ

documenting exceptions

Hello,
Are you aware of any tool which analyzes source code and documents the
exceptions thrown for each routine in each source file for a project?
Thanks
Jul 22 '05 #1
5 1229
Ian Lazarus wrote:
Hello,
Are you aware of any tool which analyzes source code and documents the
exceptions thrown for each routine in each source file for a project?
Thanks


This is one of the main reasons I don't like C++ exception syntax. I
understand there are legacy issues, but the fact that exceptions
potentially thrown by a function are not required to be part of the
signature bothers me. I believe the tool you are looking for is called a
good programmer.

--
STH
Hatton's Law: "There is only One inviolable Law"
KDevelop: http://www.kdevelop.org SuSE: http://www.suse.com
Mozilla: http://www.mozilla.org
Jul 22 '05 #2
If I was a good programmer, I'd write the tool myself.
Jul 22 '05 #3
Ian Lazarus wrote:
If I was a good programmer, I'd write the tool myself.


The obvious place to start is to do a text search on a .cpp file for
"throw" (ignoring comments), and then for each one found, search
backward to find the function body. That alone will tell you which
functions throw, and where the throws occur.

--
Mike Smith

Jul 22 '05 #4
Ian Lazarus wrote:
If I was a good programmer, I'd write the tool myself.

Sorry, I think that came across wrong. I was only suggesting that the only
way to effectively accomplish your goal is to be sure the code was written
by a programmer who understands C++ exceptions, and /does/ explicitly add
the exceptions to the declarations. I was assuming you were not only
asking about code you had written, but also about code that was written by
others. I did not intend to imply you are not qualified to do so.
--
STH
Hatton's Law: "There is only One inviolable Law"
KDevelop: http://www.kdevelop.org SuSE: http://www.suse.com
Mozilla: http://www.mozilla.org
Jul 22 '05 #5
Ian Lazarus wrote:
Hello,
Are you aware of any tool which analyzes source code and documents the
exceptions thrown for each routine in each source file for a project?
Thanks

Have you looked at Doxygen? I really don't know what it might to for you,
but it's the best bet I know of:
http://www.stack.nl/~dimitri/doxygen...l#cmdexception

And there's always:
"TODO/Wish list

"Here is a list of things that may be added in the future. As you can see,
there are way too many things on the list for me to do in any reasonable
amount of time! So if you'd like to implement one or more of these features
for me, please let me know! "

http://www.stack.nl/~dimitri/doxygen/todo.html
--
STH
Hatton's Law: "There is only One inviolable Law"
KDevelop: http://www.kdevelop.org SuSE: http://www.suse.com
Mozilla: http://www.mozilla.org
Jul 22 '05 #6

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

5
by: Isaac Rodriguez | last post by:
Hi, Are there any standarized ways of documenting Python code? When I check the __doc__ attribute of the standard modules, the results are kind of plain. Is everyone using this style? Since...
2
by: Lasse Vågsæther Karlsen | last post by:
I notice that if I use this syntax: def classname: ... ## # closes the database connection and releases the resources. def close(self): .... ##
17
by: Jelmer | last post by:
Hi, I am mildly familiar with ms access developement and I have been asked to port and document a ms access app. I expect the porting (97 to XP) to be fairly straightforward. However documenting...
1
by: strauss.sean | last post by:
I have been asked to begin documenting the ongoing development and changes to a database that I maintain. Not the entry of data; this is about the changes to how tables are restructured, and any...
13
by: Jeff Rodriguez | last post by:
What sort of documentation do you do on your code? I've never done any code development on a big project and I want to start documenting my code in a way that makes sense, is easy to understand,...
1
by: Brett | last post by:
I'd like to have all of my documentation in one place. I use the following for documenting code: - attributes for certain types of documentation - use of the C# generated inline XML...
8
by: Spleenwort | last post by:
With regard to XML comments in c#. I think that #regions should be self-documenting relative to XML comments or that a <region> tag should be defined and auto-inserted when you type #region...
2
by: sajithamol | last post by:
What is a Self Documenting Code? wheather java is a self documenting code?
3
by: dale_bertrand | last post by:
In python, how do I know what exceptions a method could raise? Do I need to look at the source? I don't see this info in the API docs for any of the APIs I'm using. Thanks in advance for your...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
1
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
1
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new...
0
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and...
0
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The...
0
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
muto222
php
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
0
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.