Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 3 years ago.
Improve this question
A trivial question perhaps, but I'm interested in the answers. I'm currently refactoring some very large monolithic string resource files (one dumpster resource file per project, in about 30 projects). I'm splitting them such that we follow a convention for our files and make the strings easier to find and manage when coding.
Generally I'm splitting the files into this scheme:
ErrorMessages.resx
LogMessages.resx
ViewResources.resx
AppResources.resx
I'm not terribly thrilled with the naming, and I'm just wondering what other people use. For example, instead of AppResources (strings for internal use by the application), I've seen a lot of demo projects use StringResources, Internal (terrible!), etc.
Ideas/anecdotes/suggestions on managing resources or standard naming schemes are appreciated.
I generally structure my resources like this:
The first resource file is used by the entire application (e.g. Project.Core) and does include all sorts of widely used common strings. I actually don't make any difference between errors/exceptions and logging:
CommonResources.resx
Access modifier: Public
Error_Contexte.g. Error_ArgumentCannotBeNull
Warn_Contexte.g. Warn_ApplicationSettingNotFoundUseDefault
Info_Contexte.g. Info_UpdateAvailable
Validation_Contexte.g. Validation_EmailNotValid
The second resource file is used by the presentation layer and contains all sorts of UI strings. The naming can vary from project to project but generally it looks like the following schema:
PresentationResources.resx
Access modifier: Internal
Common_Contexte.g. Common_Yes
Section/Controller_Window/View_Contexte.g. Help_FAQ_HeadlineHowToUseResources or Help_FAQ_TextHowToUseResources
Finally every project/assembly does also have an internal resource file for Error/Warn/Info/Validation resources that are too specific to go in the CommonResources.resx file. I have to admit, that I mostly name this resource file InternalResources.cs ;)
InternalResources.resx
Access modifier: Internal
Classname_Error_Contexte.g. BCrypt_Error_InvalidSaltRevision
Classname_Warn_Context
Classname_Info_Context
Classname_Validation_Context
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 1 year ago.
Improve this question
I wanted to know if there is a site that references "conventional" folder/file names. For example, one that explains what a "Models" folder should contain, what a "Helpers" folder should contain, etc.
I'm starting to develop projects with a lot of content, so it's important for me to start now to get the right habits to organize my work.
Thanks in advance for your help.
EDIT: To be more precise I would like to know the role of each folder/file according to their names because I see a lot of projects with Models, Helpers, etc folders and I don't really understand the difference between them.
My question is about console applications in .Net 6
A Models folder would probably contain classes like Person, Customer, Employee etc, most of the times models that are have their own data tables. A Helpers folder classes that maybe don't have a lot of logic, if that's the right word, for example an EnumeHelper class that return the description of an enum. If you want to see more about how to structure a project: https://www.youtube.com/watch?v=YiVqwoFMieg
In the description there are links to projects built with that structure, called clean architecture. I you're a beginner, maybe you want to see some beginner tutorials, see the structure there, try to understand it and gradually try to understand other architectures, like clean architecture.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I have some constant strings that are needed in multiple classes. How can I store and retrieve these constants in a way that meets these required criteria:
No duplication of information.
No function call to retrieve constants.
No namespace symbol prior to constant (IE: Constant not Namespace.Constant)
None of the solutions I've found so far meet every criteria:
Duplicate them in every class they are needed in (violates criteria #1).
Store them in a separate static class that is referenced wherever needed (a bit like a C-style header file, violates criteria #3).
Put them in one of the classes where they are used and reference that class when they are needed elsewhere (this is seems like a bad idea because it could create circular references, and it violates criteria #3).
Put them in app.config and retrieve them whenever they are needed (This seems to break style conventions since non-configuration data is stored in a config file, and a change to the config file could break application logic. It also violates criteria #2).
Is there a solution in C# that meets every criteria?
I use option #2 often, because #1 is rife with risk of different values, and #3 breaks normally-sought class encapsulation. If you must have globals. have one Single Source of Truth for them.
You can make the code somewhat cleaner with a using alias:
using static namespace.StaticClassName;
VB.Net has Module Statement that can be used for global variables that can be accessed without using the name of the module, but C# doesn't have anything like that.
In C# I use #2, but with const. That way the value is shown when you hover it in Visual Studio:
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 7 years ago.
Improve this question
A "God Namespace" is the (uncommon) term for an (anti?)pattern analogous to the "God Object", when you stuff a metric ton of stuff (mostly methods/functions) that is not related or not closely related to each other into one huge namespace/static class just so that it can be used in multiple sections of your project.
When following that (anti?)pattern, you often end up, as a C# example, with something like a static class Assets with tons of methods mostly unrelated to each other, but used across multiple places in your project(s).
I usually approach this problem by letting the next Assets grow for as much as I can bear it, and then desperately try to sort its contents out into several smaller ones based on the criteria which seems most legit, like MathAssets, or BitmapAssets, or RNGAssets, and then end up forgetting what did I put where... and make a new Assets for several new methods which don't fit into either of the SomethingAssets already cluttering up the project.
Are there any other ways of clearing up the "God Namespace"? Or will I just have to live with good old static class Assets?
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 8 years ago.
Improve this question
I'm being tasked with making a modular program that uses external, easy to edit files to dictate if certain elements are shown, what classes are used, etc.
Using C# and Visual Studio 2008, what type of file should I use? I was suggested .ini, but there is also talk of using .xml for it?
Which file would be best, and is there a built-in C# method of working with those files?
There's a heap of different ways for achieving different things. You could for example use an appSetting in an app.config file to turn features on and off. If you wanted to change classes or services that are used, then you could use DI/IoC with something like Castle Windsor and configure that in code and or xml.
If you can be more specific with what you want to achieve, and some examples in code, you can probably get some better answers.
you can use custom sections in your config files.
Config files are xml, well known files in .net context.
See example here: http://msdn.microsoft.com/en-us/library/vstudio/2tw134k3(v=vs.100).aspx
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
I have three projects(C# libraries) namely A,B,C.
All the 3 have 3-4 xml files(in general can be resources) associated with them.
Each of these projects have classes that access these files for settings and information.
(loading xmls when ever they need)
The problems is sometimes there is a need that a class in project C may need to access
resources(xml files,images etc) of project B and vice versa.
Also these files may or may not be a part of the project solution.These resource paths
can come from app.config etc.
Its really becoming tedious to work out how to centralise access to these resources so that
all three projects can access them uniformly.
Currently all the projects load the files using app.config.
Also i'm trying to minimise the number of times a xml is loaded.(ideally once).
But given the projects are different i have to load it again.
I thought of using a Singleton class as it would make more sense for making uniform access but haven't quiet figured out a way.
Anyone has come across similar situations?
Are there any design patterns or best practices for sharing resources across projects?
Create one library containing the class(es) that access your centralized XML settings, and reference that library from the other libraries.
You don't necessarily need a Singleton for this, but putting it in one place will allow you to focus your efforts on things to improve it later, possibly caching, etc.