dgh2112 / browse-and-doc-it Goto Github PK
View Code? Open in Web Editor NEWA RAD Studio IDE plug-in to allow you to browse your code and provide support for documentation, coding checks and metrics.
License: Other
A RAD Studio IDE plug-in to allow you to browse your code and provide support for documentation, coding checks and metrics.
License: Other
Object Pascal Grammar.bnf seems to lack the new (as of 11.0 Alexandria) % binary literal prefix and that one can write big numerical literals like this: 1_000_000 where _ is the thousands separator.
Pascal Parser - Interface and Implementation nodes should goto those Uses clauses
Implement Interfaces for all objects so that memory is managed automatically. This will also allow interfaces to be implemented by objects and not require the interface to be inherited.
Inserting comments does not use the active Sub-Editor View, i.e., adding a block comment to the .h
file inserts the comment in the .cpp
file.
Splits explorer and documentation options.
Add the ability for the editors to show warnings, errors, hints, etc as icons at the end of the line of code - reference Uwe's article on drawing in the editor.
Add the ability to BaDI to automatically update the module date and increment the version number. WRT the version number, if we can detect the number of lines checked the incrementation can be group as follows:
Thresholds should be configurable.
Successfully compiled and installed BrowseAndDocItRS110.dll in Delphi 11.1. When trying to open the BrowseAndDocIt page in the IDE's Options dialog, I get this error message:
Hints do not align the comment of the method!
In-line variables and constants cause access violations in DPR (and probably DPK files) fills.
AV with
Procedure DoSomething;
Proc
Begin
End;
There are TOO MANY ERRORS in \Source\BADI.ModuleExplorerFrame.pas
In-Line constants are marked as hard coded.
Module Explorer does not use the current Editor when hidden at the side of the IDE
Add options for the automatic updating of the module version and date.
Allow the user through the options pages to configure what type of comment is used for different comment insertions, for instance, methods use (** **) by default but allow the user to reconfigure /// comments instead.
This will need to distinguish between languages as well: Pascal, C++, VB, etc.
Add the ability to set individual metric font colours and styles.
Add Metrics to documentation
This will require the following:
///
as document comments;@tags
;@tags
verse /// <tags>
.Literal strings found in external procedure references!
AV on typing
Implementation
Uses
System.
End;
Add Checks to documentation
Add optional percentages to the metrics output (along with the maximum reference, say 2/8 (25%).
Please provide this IDE plugin and others you created via GetIt package manager to make it easier to discover and install.
Here's a link to the form for submitting: https://getitnow.embarcadero.com/submit/
@nohint does not always find all tags
Answering NO to failed parsing of code re-parsed code when it shouldn't.
Unit test for date conversation fail when run outside of the UK locale settings as the tests were written with did mmm yyyy in mind.
These tests need to be updated to handle multiple locales.
Create a Word/PDF manual for BADI instead of the web page.
Add CHM format to documentation
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.