我有一个典型的OO模式:一个基本抽象类(定义抽象方法)和几个以特定于类的方式实现这些抽象方法的类。我习惯于在抽象方法中只编写一次文档，然后它会自动传播到几个具体类(至少它在Javadoc、Scaladoc、Doxygen中按以下方式工作)，即我不需要重复所有具体类中的相同描述。但是，我找不到如何在YARD中进行此类传播。我试过，例如:#Somedescriptionofabstractclass.#@abstractclassAbstractClass#Somemethoddescription.#@return[Symbol]somereturndescription#@abstra

关闭。这个问题是opinion-based.它目前不接受答案。想改善这个问题吗？更新问题，以便可以通过editingthispost用事实和引文回答问题.3年前关闭。Improvethisquestion我不确定这里的最佳实践是什么，但我经常看到缩写的变量名，尤其是当范围很小的时候。所以(使用简单的Ruby示例)而不是defadd_location(name,coordinates),我看到类似defadd_loc(name,coord)的东西——我什至可能会看到类似defadd_loc(n,x,y)的东西.我想当人们习惯于看到缩写时，更长的名字可能会让他们感到疲倦。冗长是否有助于可读

我正在努力使用JSDocs记录router.get调用。如果我尝试将文档附加到我的路由器调用本身，我无法让文档在页面上正确显示。/***Healthcheck*@memberofhealth*/router.get('/happy',function(req,res){res.json({"status":"OK"});});为了解决这个问题，我为函数命名。router.get('/happy',happy);/***Healthcheck*@memberofhealth*/functionhappy(req,res){res.json({"status":"OK"});}这行得通，但