Is it possible to insert inline (in-text) citations in the documentation with Doxygen? Normally when you use \cite <bibtex_id> it inserts the bibliography index of the paper in brackets like [3]. However I want to insert the bibliography item itself. It would be great to list bibiliography references in the See also section with \see.
Is it possible?
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 3 years ago.
Improve this question
I read a bunch of the articles a questions asking about capitalizing SQL keywords (SELECT, FROM, WHERE, etc.), but I couldn't find a thread for the following:
Should I capitalize SQL functions, like SUM(), COUNT(), etc.? The teacher of a class I took used to capitalize the functions, but a software engineer at work told me not to.
Is there a convention?
In short, it really comes down to personal preference/style. It's a traditional convention that's been around for ages to always use upper case letters for reserved words in SQL (see here: https://www.sqlstyle.guide/#query-syntax) and the idea is that even if someone is not using an IDE that highlights the reserved words, they can still easily differentiate between the reserved keywords and other stuff such as column and table names.
Personally, I think capitalizing the reserved words just makes the SQL code look like it's from 30 years ago and constantly using shift or caps lock while typing is just not something I want to do. There are auto-formatting extensions that you can use but honestly...why?
Yes, capitalizing SQL statements is a convention and I strongly suggest to use it. Like others wrote in this thread it really helps with reading scripts (you will see that they can be really big).
T-SQL conventions from MS: link
From what I've seen it is personal preference, but it will have no effect on how your query runs. I do because I think it makes the query more readable, but if your team does not want you to then you shouldn't.
I use SQLPrompt extension which corrects what you type to UPPER case when needed by convention.
Yes, COUNT(), SUM() and other functions are capitalized by SQL Prompt.
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 want to detect and solve the violations of the Law of Demeter in ＡＢＡＰ．
the focus is on the classe level.
Dose anyone have some idea or articles?
please reply
best regards
yinxiao
Okay,
this is what you will need to use ( and more ):
READ REPORT <prog> INTO <itab>. This will read code into an internal table for analysis
SYNTAX-CHECK FOR <prog> MESSAGE <m> LINE <l> WORD <w> PROGRAM <itab>. This will syntax check any changes you make to code
CALL FUNCTION 'RS_DELETE_PROGRAM' Before saving a changed report, you might have to delete it first
INSERT REPORT p_abap FROM it_prog. This will create the changed report from a changed itab
GENERATE REPORT p_abap. This will generate the report you inserted
Analysis of the table TRDIR, for class name XYZ you will find in it all components with the names XYZ========<componentname>, these are all reports that you can read and modify
I would also look into how SAP does 'where used', it might help you to find violations in an easy fashion
A word to the wise : there is no way that SAP will support this; 80% of these keywords are reserved for internal use only ( those keywords are of course the most interesting ;), if this is not an academic exercise, then you are almost certainly wasting your time.
Also, I am not sure that code that complies to Demeter's law is necessarily better code, but that's a philosophical discussion best had with beer.
T.
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
What is the idiomatic way to document function definitions (defn) in Clojure? In particular, should we use "#param", "#returns", etc. to document parameters, return values, etc.?
Is there some standard way to specify expected parameter types (other that type hints) in this dynamically typed language?
There does not seem to be a very strong tendency to use #param tags though I think they may be more common. the #returns tag it perhaps less applicable because it would make a lot of sense to put the entire description of what the function does under the #returns tag.
typically the code in clojure.core sticks to describing what the function does and a lot of them start with the word "return".
(defn rand-nth
"Return a random element of the (sequential) collection. Will have
the same performance characteristics as nth for the given
collection."
There is a tendency in idomatic clojure code to try to use the build in sequence abstractions for most functions so rand-nth's doc string could look like:
(defn rand-nth
"#Params: any seq
#Returns a random element of the (sequential) collection. Will have
the same performance characteristics as nth for the given
collection."
which does not really say a lot more than the origional.
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
When I used to use VB 6 in my high school MSDN was just fantastic, I never looked anywhere else for help. Then came .NET and online MSDN and whatnot, and there were no longer any practical examples of anything. I slowly started to avoid MSDN and now when I search something on Google I straight away add -msdn in there.
If you take a simple example of ArrayList count there is nothing mentioning that count has to be used like this:
ArrayList tmpArray = new ArrayList();
tmpArray.Add("something");
LabelCount.text = tmpArray.Count;
The way MSDN has it is actually really helpful if you have a basic idea of what member variables are etc. But if you are new to C# in general, you would be completely lost.
PHP documentation is so neat! A simple strlen has a neat depiction of what are the return values, parameters for function etc, plus the comment section has lots of users giving out so many valuable usage example of strlen which I find really amazingly relevant and helpful.
Is there a way to look at things and understand in MSDN? How do you guys refer MSDN?
Microsoft's documentation does not have the beauty and simplicity that linux man or info has, but still, it's very comprehensive. You need to know that it's not tutorials in most cases, it's reference documentation, that assumes you already know how to use that function.
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
Wikipedia provides a number of citations used in the sciences, however does one stand out in computer science and software engineering related documents? My initial guess is to the IEEE format, as they have a number of conferences and publications related to both fields, but I couldn't find anything definite.
I think I used both APA and MLA styles at different points. Unlike journalism or psychology, there isn't a defined standard, so it will probably depend the most on the school/professors that you have.
Follow the standards of the publication you plan on submitting to. All conferences and journals should have formatting information available during the submission process, and will often even provide LaTeX stubs that you can work off of.
If you're just doing a paper for a class, check with your professor if there's a publication's formatting style they prefer, and if they don't have one, feel free to pick your own out of the stubs you can get a hold of.
The big takeaway here is that if you're worrying about measuring margins and placing commas, you're either reinventing the wheel, not using LaTeX, or probably both, and if you're serious about participating in the academic side of CS, it's something you should learn as soon as possible.
Typically in college for Com Sci you will be using the MLA citation standards at least from what I have found here in the US.
You'll usually see APA style or MLA style citations used in university CS departments in the US. MLA has been more widely used in the past because it has been used in journalism for years, but APA is gaining ground in academics (not only in CS, but in many fields).
Whatever LaTeX happens to generate. Since there's no standard, I go with the most convenient one.
I've always used APA style when I write things on paper, but my preferred form is the hyperlink. This is CS, after all :)
I think I am little late on this thread. But I am just gonna share some resource in case someone stumbles here. They do have a standardized citation format. In fact, the format may vary from institute to institute. In case your institute has a different format, you can always go for ieee citation machine. They help you generate citations automatically.