Advertisement

On Comments in Visual Languages

  • Christoph Daniel SchulzeEmail author
  • Christina Plöger
  • Reinhard von Hanxleden
Conference paper
Part of the Lecture Notes in Computer Science book series (LNCS, volume 9781)

Abstract

Visual languages based on node-link diagrams can be used to develop software and usually offer the possibility to write explanatory comments. Which node a comment refers to is usually not made explicit, but is implicitly clear to readers through placement and content. While automatic layout algorithms can make working with diagrams more productive, they tend to destroy such implicit clues because they are not aware of them and thus do not preserve the spatial relationship between diagram elements. Implicit clues thus need to be inferred and made explicit to be taken into account by layout algorithms. In this paper, we improve upon a previous paper on the subject [9], introducing further heuristics that aim to describe relations between comments and nodes. These heuristics mainly help to reduce the number of attachments of comments that should not be attached to anything. We also derive propositions on how developers of visual languages should integrate comments.

Keywords

Font Size Node Reference Textual Language Visual Language Layout Algorithm 
These keywords were added by machine and not by the authors. This process is experimental and the keywords may be updated as the learning algorithm improves.

References

  1. 1.
    Buse, R.P., Weimer, W.R.: Automatic documentation inference for exceptions. In: Proceedings of the 2008 International Symposium on Software Testing and Analysis, ISSTA 2008, pp. 273–282. ACM (2008)Google Scholar
  2. 2.
    Eichelberger, H.: Aesthetics and automatic layout of UML class diagrams. Ph.D. thesis, Bayerische Julius-Maximilians-Universität Würzburg (2005)Google Scholar
  3. 3.
    Kramer, D.: API documentation from source code comments: a case study of Javadoc. In: Proceedings of the 17th Annual International Conference on Computer Documentation, SIGDOC 1999, pp. 147–153. ACM (1999)Google Scholar
  4. 4.
    Misue, K., Eades, P., Lai, W., Sugiyama, K.: Layout adjustment and the mental map. J. Vis. Lang. Comput. 6(2), 183–210 (1995)CrossRefGoogle Scholar
  5. 5.
    Petre, M.: Cognitive dimensions beyond the notation. J. Vis. Lang. Comput. 17(4), 292–301 (2006)CrossRefGoogle Scholar
  6. 6.
    Ptolemaeus, C. (ed.): System Design, Modeling, and Simulation Using Ptolemy II. Ptolemy.org (2014). http://ptolemy.eecs.berkeley.edu/books/Systems/
  7. 7.
    Schulze, C.D., Plöger, C., von Hanxleden, R.: On comments in visual languages. Technical report 1602, Christian-Albrechts-Universität zu Kiel, Department of Computer Science, April 2016. ISSN: 2192–6247Google Scholar
  8. 8.
    Schulze, C.D., Spönemann, M., von Hanxleden, R.: Drawing layered graphs with port constraints. J. Vis. Lang. Comput. Spec. Issue Diagram Aesthetics Layout 25(2), 89–106 (2014)CrossRefGoogle Scholar
  9. 9.
    Schulze, C.D., von Hanxleden, R.: Automatic layout in the face of unattached comments. In: Proceedings of the IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC 2014), Melbourne, Australia, July 2014Google Scholar
  10. 10.
    Sugiyama, K., Tagawa, S., Toda, M.: Methods for visual understanding of hierarchical system structures. IEEE Trans. Syst. Man Cybern. 11(2), 109–125 (1981)MathSciNetCrossRefGoogle Scholar

Copyright information

© Springer International Publishing Switzerland 2016

Authors and Affiliations

  • Christoph Daniel Schulze
    • 1
    Email author
  • Christina Plöger
    • 1
  • Reinhard von Hanxleden
    • 1
  1. 1.Deptartment of Computer ScienceKiel UniversityKielGermany

Personalised recommendations