我是一名Java开发人员,我有兴趣在我编写的代码和程序中提高Javadoc注释的质量,使其更容易理解,更容易让其他开发人员实现.
我已经阅读了很多文章,包括来自官方资源的文章,我尝试遵循"Java风格的元素"一书中所述的指导方针 ,但尽管如此,在网上广泛搜索后,我似乎无法找到将我现有的Javadoc与模型示例进行比较并维护Java API文档的最佳实践的实用方法.
或者这是一个神话?在任何官方文档中都看不到它(它就在那里,天哪!) - 当将 Atom 与 go-plus 包一起使用时,它似乎对我不起作用。很遗憾,因为我正在做很多数学运算,而且我喜欢数学符号。
更新:我不认为任何数学符号是深奥的:??? 与任何表情符号相比:
一个是或否的答案并参考官方来源就足以打勾!
更新:感谢 elithrar 的回答,我找到了“拉丁字母横向点击”?成为我想要的“双垂直线”的看似完美的类比。
请考虑以下示例代码:
-- Update the fields of a record. (It must have the fields already.)
{ person |
name = "George" }
-- Update multiple fields at once, using the current values.
{ particle |
position = particle.position + particle.velocity,
velocity = particle.velocity + particle.acceleration }
Run Code Online (Sandbox Code Playgroud)
资料来源:X分钟学习榆树
|在这个例子中,人们应该怎么读,而在Elm中呢?
我在set-builder符号中熟悉它作为"where"/"this that",并且在Haskell中的列表理解中它具有非常相似的目的,例如
[ x*2 | x <- [1..10] ]
在逻辑上等同于
来源:了解你一个Haskell
(显然我也熟悉它在C语言中作为一元"或"运算符的用法)
什么样的type Msg = Increment | Decrement?
资料来源:https://guide.elm-lang.org
或者,在此示例中讨论联盟类型时:
type Boolean
= …Run Code Online (Sandbox Code Playgroud) 我想用这个paintComponent(..)方法打印一些文字.
@Override
protected void paintComponent(Graphics g) {
super.paintComponent(g);
g.setColor(Color.red);
g.drawString("Hello world", 10, 10);
}
Run Code Online (Sandbox Code Playgroud)
但是文字有些麻烦.你怎么能用这种方法用[抗锯齿]强制文本绘图?
谢谢.
我正在大学学习C++,在休息期间,我将通过Strousrtup的"CPP编程语言第4版"来填补我理解的空白以及我们在课堂上教授的内容.
在3.3.1节中,他详细介绍了矢量类的简化版本的代码片段(特定于类型,仅为双精度型):
Vector& Vector::operator=(const Vector& a) {
double* p = new double[a.sz];
for (int i=0; i!=a.sz; ++i)
p[i] = a.elem[i];
delete[] elem;
elem = p;
sz = a.sz;
return *this;
}
Run Code Online (Sandbox Code Playgroud)
现在,我已经写了我自己的一个重写的拷贝赋值运算符的版本之前,我看到了这一点,这似乎正常工作与这种简化的准向量一起去,但我想知道,有什么不对删除分配的内存elem点,然后重新初始化它,我做以下,比Stroustrup的是如何做的?
vectoR& vectoR::operator=(const vectoR& v) {
delete[] elem;
elem = new double[v.size()];
sz = v.size();
for (int i = 0; i != sz; ++i)
elem[i] = v[i];
return *this;
}
Run Code Online (Sandbox Code Playgroud)